Sign in

v1

latestOpenAPI 3.0.02026-07-2641723.8 KB

Order a verification

Orders a new verification.

<Note> [Create a user](/api-reference/verifications-guide#create-a-user) or update an existing user with the required details before ordering payroll, government, banking, or document verifications. </Note>
post/v2/verifications

Request body

userstring uuid required

User ID for the verification.

Response

idstring uuid

Unique ID of the verification.

userstring uuid

ID of the user associated with the verification.

created_atstring date-time

Timestamp (ISO 8601) when the verification was requested.

updated_atstring date-time

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

channel'api' | 'encompass'

Origin of the verification order.

data_source'payroll' | 'banking' | 'documents'

Source of verification data.

Example response

{
  "channel": "api",
  "status": {
    "errors": [
      {
        "code": "self-employed_income",
        "title": "Self-employed income",
        "message": "Self-employed income cannot be assessed using Paystub and W2 Data.",
        "resources": [
          {
            "id": null,
            "type": "employments",
            "name": "Freelance Consulting LLC"
          }
        ]
      }
    ]
  },
  "report": {
    "file_url": "www.argyle.com/storagename/pdf",
    "json_url": "www.argyle.com/storagename/json"
  }
}