Skip to main content
GET
/
v2
/
verifications
List all verifications
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/verifications \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "created_at": "2023-03-09T16:22:06.081Z",
    "updated_at": "2023-03-09T16:22:06.081Z",
    "channel": "api",
    "status": {
      "state": "COMPLETED",
      "code": "completed",
      "errors": []
    },
    "report": {
      "id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95",
      "type": "doc-voi-mortgage",
      "file_url": "https://api-sandbox.argyle.com/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/pdf",
      "json_url": "https://api-sandbox.argyle.com/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/json"
    },
    "employments": [
      {
        "employer": "Starbucks",
        "status": "active",
        "hire_date": "2015-08-28",
        "termination_date": null
      }
    ],
    "loan": {
      "number": "1234",
      "borrower_id": "ABC789",
      "application_id": "2121313",
      "officer_email": "[email protected]"
    },
    "billing": {
      "cost_center": "5"
    }
  },
  {
    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc3333",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9345",
    "created_at": "2023-03-10T05:14:06.081Z",
    "updated_at": "2023-03-10T13:03:06.081Z",
    "channel": "api",
    "status": {
      "state": "PROCESSING",
      "code": "documents_processing",
      "errors": []
    },
    "report": {
      "id": null,
      "type": "doc-voi-mortgage",
      "file_url": null,
      "json_url": null
    },
    "employments": [
      {
        "employer": "Starbucks",
        "status": "active",
        "hire_date": "2019-01-01",
        "termination_date": null
      }
    ],
    "loan": {
      "number": "1234",
      "borrower_id": "ABC789",
      "application_id": "2121313",
      "officer_email": "[email protected]"
    },
    "billing": {
      "cost_center": "5"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

​
user
string<uuid>

Filter by user ID.

​
status_state
enum<string>

Filter by verification status state.

Available options:
PENDING,
PROCESSING,
PAUSED,
CANCELLED,
COMPLETED
​
status_code
enum<string>

Filter by verification status code.

Available options:
pending,
documents_processing,
more_data_required,
report_available,
waiting_on_third_party,
report_generating,
argyle_timeout,
cancelled_by_client,
completed,
completed_with_errors
​
report_type
enum<string>

Filter by report type.

Available options:
doc-voi-mortgage
​
loan_number
string

Filter by loan number.

​
limit
integer

Number of verification objects returned per page. Default: 10. Maximum: 200.

Response

200 - application/json

Array of verification objects.

​
id
string<uuid>

Unique ID of the verification.

​
user
string<uuid>

ID of the user associated with the verification.

​
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
string

Origin of the verification order.

​
status
object

Verification status information.

​
report
object

Report information.

​
employments
object[]

List of employments for the user.

​
loan
object

Optional loan details.

​
billing
object

Optional billing details.