Skip to main content
POST
/
partners
/
v2
/
verifications
curl --request POST \
  --url https://api-sandbox.argyle.com/partners/v2/verifications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "report": {
    "type": "voie"
  },
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  }
}
'
{
  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
  "created_at": "2023-03-09T16:22:06.081Z",
  "updated_at": "2023-03-09T16:22:06.081Z",
  "channel": "api",
  "status": {
    "state": "PENDING",
    "code": "pending",
    "errors": []
  },
  "report": {
    "id": null,
    "type": "voie",
    "file_url": null,
    "json_url": null
  },
  "employments": [],
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  },
  "data_source": "payroll"
}

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json

Request body for ordering a verification.

  • user and report are required for all requests.
  • employments is required for document verifications only.
  • report.configuration is used for banking verifications only.
  • loan and billing apply to regular payroll and mortgage verification workflows.
user
string<uuid>
required

User ID for the verification.

report
object
required

Report request configuration.

employments
object[]

List of employments for the user.

Required for document verifications only. Not used for payroll or banking verifications.

loan
object

Optional loan details for regular payroll and mortgage verification workflows.

billing
object

Optional billing details for regular payroll and mortgage verification workflows.

Response

200 - application/json
id
string<uuid>

Unique ID of the verification.

user
string<uuid>

ID of the user associated with the verification.

client
string<uuid>

ID of the client on whose behalf the verification was requested.

created_at
string<date-time>

Timestamp (ISO 8601) when the verification was requested.

updated_at
string<date-time>

Timestamp (ISO 8601) when the verification object was last updated.

channel
enum<string>

Origin of the verification order.

Available options:
api,
encompass
Example:

"api"

status
object

Verification status information.

report
object

Report information.

employments
object[]

List of employments for the user. Documents only.

loan
object

Optional loan details for regular payroll and mortgage verification workflows.

billing
object

Optional billing details for regular payroll and mortgage verification workflows.

data_source
enum<string>

Source of verification data.

Available options:
payroll,
banking,
documents