Partner Verifications

Order banking and document-based income verifications.

#The verifications object

Attributes

#
idstring (uuid)
Unique ID of the verification.
#
userstring (uuid)
ID of the user associated with the verification.
#
clientstring (uuid)
ID of the client on whose behalf the verification is requested.
#
created_atstring (datetime)
Timestamp (ISO 8601) when the verification was requested.
#
updated_atstring (datetime)
Timestamp (ISO 8601) when the verification object was last updated.
#
channelstring
Origin of the verification order.
#
data_sourcestring (enum)

statusobject

Verification status information.

statestring (enum)

Verification state.

codestring (enum)

Verification status code.

errorsarray of objects

Error information.

Error details, such as what caused a PAUSED state or prevented GSE eligibility for a COMPLETED document verification.

codestring (enum)

Error code.

codestring

Error title.

messagestring

Error message.

resourcesarray of objects

Additional troubleshooting resources (e.g. the ID of an unmatched document).

reportobject

Report information.

idstring (uuid)

Unique ID of the report.

Only available when verification state is COMPLETED

typestring (enum)

The type of report.

file_urlstring

Download link to the report PDF.
— Requires Argyle authentication headers.

Only available when verification state is COMPLETED

json_urlstring

Download link to the report in JSON.
— Requires Argyle authentication headers.

Only available when verification state is COMPLETED

from_datestring (datetime)

optional

Earliest date used for banking report history (up to 2 years).

Banking only.

income_stream_confidence_minimuminteger

optional

Minimum income confidence threshold for banking reports.

Banking only.

report_custom_fieldsarray of objects

optional

Custom fields returned in report JSON as pass-through values.

Banking only.

employmentsarray of objects

List of employments for the user.

Documents only.

employerstring

Name of the employer.

statusstring (enum)

User's current employment status at this employer.

hire_datestring (date)

Employment start date in ISO 8601 format.

termination_datestring (date)

optional

Employment end date in ISO 8601 format.

null when employment status is active

loanobject

Optional loan details.

numberstring

Loan number or identifier.

borrower_idstring

Borrower identifier.

application_idstring

Application identifier.

officer_emailstring

Email of the loan officer requesting the verification.

billingobject

Optional billing details.

cost_centerstring

Cost center identifier.

Example

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "data_source": "documents",
9  "status": {
10    "state": "PENDING",
11    "code": "pending",
12    "errors": []
13  },
14  "report": {
15    "id": null,
16    "type": "doc-voi-mortgage",
17    "file_url": null,
18    "json_url": null
19  },
20  "employments": [
21    {
22      "employer": "Starbucks",
23      "status": "active",
24      "hire_date": "2015-08-28",
25      "termination_date": null
26    }
27  ],
28  "loan": {
29    "number": "1234",
30    "borrower_id": "ABC789",
31    "application_id": "2121313",
32    "officer_email": "[email protected]"
33  },
34  "billing": {
35    "cost_center": "5"
36  }
37}

#Order a verification

post/partners/v2/verifications

Orders a new verification.

Create a user or update an existing user with required fields before ordering document and banking verifications.

Request body

#
clientstring (uuid)
required
ID of the client on whose behalf the verification is requested.
#
userstring (uuid)
required
User ID for the verification.
Required for both banking and document verifications.

employmentsarray of objects

required

List of employments for the user.

Documents only.

employerstring

required

Name of the employer.

statusstring (enum)

required

User's current employment status at this employer.

hire_datestring (date)

required

Employment start date in ISO 8601 format.

termination_datestring (date)

optional

Employment end date in ISO 8601 format.

Required when employment status is previous

reportobject

required

typestring

required

The type of report to generate.

from_datestring (datetime)

optional

Earliest date used for banking report history (up to 2 years).

Banking only.

income_stream_confidence_minimuminteger

optional

Minimum income confidence threshold for banking reports.

Banking only.

report_custom_fieldsarray of objects

optional

Custom fields returned in report JSON as pass-through values.

Banking only.

loanobject

optional

Optional loan details.

numberstring

optional

Loan number or identifier.

borrower_idstring

optional

Borrower identifier.

application_idstring

optional

Application identifier.

officer_emailstring

optional

Email of the loan officer requesting the verification.

billingobject

optional

cost_centerstring

optional

Cost center identifier.

Example Request (Documents)

1curl --request POST \
2     --url https://api.argyle.com/partners/v2/verifications \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "client": "019a91a4-646c-c82a-9a61-401910b67435",
7        "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
8        "employments": [
9            {
10                "employer": "Starbucks",
11                "status": "active",
12                "hire_date": "2015-08-28",
13                "termination_date": null
14            }
15        ],
16        "report": {
17            "type": "doc-voi-mortgage"
18        },
19        "loan": {
20            "number": "1234",
21            "borrower_id": "ABC789",
22            "application_id": "2121313",
23            "officer_email": "[email protected]"
24        },
25        "billing": {
26            "cost_center": "5"
27        }
28     }'

Example Request (Banking)

1curl --request POST \
2     --url https://api.argyle.com/partners/v2/verifications \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "client": "019a91a4-646c-c82a-9a61-401910b67435",
7        "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
8        "report": {
9            "type": "voai",
10            "from_date": "2024-01-01T00:00:00Z",
11            "income_stream_confidence_minimum": 50,
12            "report_custom_fields": [
13                {
14                    "label": "loanID",
15                    "value": "12345",
16                    "shown": true
17                }
18            ]
19        },
20        "loan": {
21            "number": "1234",
22            "borrower_id": "ABC789",
23            "application_id": "2121313",
24            "officer_email": "[email protected]"
25        },
26        "billing": {
27            "cost_center": "5"
28        }
29     }'

Example Response (Documents)

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "status": {
9    "state": "PENDING",
10    "code": "pending",
11    "errors": []
12  },
13  "report": {
14    "id": null,
15    "type": "doc-voi-mortgage",
16    "file_url": null,
17    "json_url": null
18  },
19  "employments": [
20    {
21      "employer": "Starbucks",
22      "status": "active",
23      "hire_date": "2015-08-28",
24      "termination_date": null
25    }
26  ],
27  "loan": {
28    "number": "1234",
29    "borrower_id": "ABC789",
30    "application_id": "2121313",
31    "officer_email": "[email protected]"
32  },
33  "billing": {
34    "cost_center": "5"
35  }
36}

Example Response (Banking)

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "data_source": "banking",
9  "status": {
10    "state": "PENDING",
11    "code": "pending",
12    "errors": []
13  },
14  "report": {
15    "id": null,
16    "type": "voai",
17    "file_url": null,
18    "json_url": null,
19    "from_date": "2024-01-01T00:00:00Z",
20    "income_stream_confidence_minimum": 50,
21    "report_custom_fields": [
22      {
23        "label": "loanID",
24        "value": "12345",
25        "shown": true
26      }
27    ]
28  },
29  "employments": [],
30  "loan": {
31    "number": "1234",
32    "borrower_id": "ABC789",
33    "application_id": "2121313",
34    "officer_email": "[email protected]"
35  },
36  "billing": {
37    "cost_center": "5"
38  }
39}

#Retrieve a verification

get/partners/v2/verifications/{id}

Retrieves a verification.

Path parameters

#
idstring (uuid)
required
ID of the verification to be retrieved.

Example Request

1curl --request GET \
2     --url https://api.argyle.com/partners/v2/verifications/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Example Response

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "status": {
9    "state": "PENDING",
10    "code": "pending",
11    "errors": []
12  },
13  "report": {
14    "id": null,
15    "type": "doc-voi-mortgage",
16    "file_url": null,
17    "json_url": null
18  },
19  "employments": [
20    {
21      "employer": "Starbucks",
22      "status": "active",
23      "hire_date": "2015-08-28",
24      "termination_date": null
25    }
26  ],
27  "loan": {
28    "number": "1234",
29    "borrower_id": "ABC789",
30    "application_id": "2121313",
31    "officer_email": "[email protected]"
32  },
33  "billing": {
34    "cost_center": "5"
35  }
36}

#Update a verification

patch/partners/v2/verifications/{id}

Updates a verification.

After a verification is updated, it will re-enter the PROCESSING state.

Path parameters

#
idstring (uuid)
required
ID of the verification to be updated.

Request body

#
loanobject
optional
#
borrower_idstring
optional
Borrower identifier.
Can be updated at any time, regardless of verification status.
#
employmentsarray of objects
optional
Can only be updated when verification state is PAUSED
Updating employments will act like a PUT request (the entire employments array will be replaced by the new employments array provided).
#
employerstring
required
Name of the employer.
#
statusstring (enum)
required
User's current employment status at this employer.
#
hire_datestring (date)
required
Employment start date in ISO 8601 format.
#
termination_datestring (date)
optional
Employment end date in ISO 8601 format.
Required when employment status is previous

Example Request

1curl --request PATCH \
2     --url https://api.argyle.com/partners/v2/verifications/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "loan": {
7          "borrower_id": "5678"
8        }
9        "employments": [
10          {
11              "employer": "Starbucks",
12              "status": "previous",
13              "hire_date": "2015-08-28",
14              "termination_date": "2023-05-01"
15          },
16          {
17              "employer": "Amazon",
18              "status": "active",
19              "hire_date": "2023-06-15",
20              "termination_date": null
21          }
22        ]
23     }'

Example Response

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "status": {
9    "state": "PROCESSING",
10    "code": "documents_processing",
11    "errors": []
12  },
13  "report": {
14    "id": null,
15    "type": "doc-voi-mortgage",
16    "file_url": null,
17    "json_url": null
18  },
19  "employments": [
20    {
21      "employer": "Starbucks",
22      "status": "previous",
23      "hire_date": "2015-08-28",
24      "termination_date": "2023-05-01"
25    },
26    {
27      "employer": "Amazon",
28      "status": "active",
29      "hire_date": "2023-06-15",
30      "termination_date": null
31    }
32  ],
33  "loan": {
34    "number": "5678",
35    "borrower_id": "ABC789",
36    "application_id": "2121313",
37    "officer_email": "[email protected]"
38  },
39  "billing": {
40    "cost_center": "5"
41  }
42}

#Cancel a verification

post/partners/v2/verifications/{id}/cancel

Cancels a verification order.

Only verifications in the PAUSED state can be cancelled.

Path parameters

#
idstring (uuid)
required
ID of the verification to be cancelled.

Example Request

1curl --request POST \
2     --url https://api.argyle.com/partners/v2/verifications/{id}/cancel \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Example Response

1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "client": "019a91a4-646c-c82a-9a61-401910b67435",
5  "created_at": "2023-03-09T16:22:06.081Z",
6  "updated_at": "2023-03-09T16:22:06.081Z",
7  "channel": "api",
8  "status": {
9    "state": "CANCELLED",
10    "code": "cancelled_by_client",
11    "errors": []
12  },
13  "report": {
14    "id": null,
15    "type": "doc-voi-mortgage",
16    "file_url": null,
17    "json_url": null
18  },
19  "employments": [
20    {
21      "employer": "Starbucks",
22      "status": "active",
23      "hire_date": "2015-08-28",
24      "termination_date": null
25    }
26  ],
27  "loan": {
28    "number": "1234",
29    "borrower_id": "ABC789",
30    "application_id": "2121313",
31    "officer_email": "[email protected]"
32  },
33  "billing": {
34    "cost_center": "5"
35  }
36}

#List all verifications

get/partners/v2/verifications

Returns an array of all verifications.

Query parameters

#
userstring
optional
Filter by user ID.
#
status_statestring
optional
Filter by verification status state
#
status_codestring
optional
Filter by verification status code
#
report_typestring
optional
Filter by report type
#
loan_numberstring
optional
Filter by loan number
#
limitinteger
optional
Number of verification objects returned per page. Default: 10. Maximum: 200.

Example Request

1curl --request GET \
2     --url https://api.argyle.com/partners/v2/verifications?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Example Response

1[
2  {
3    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
4    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5    "client": "019a91a4-646c-c82a-9a61-401910b67435",
6    "created_at": "2023-03-09T16:22:06.081Z",
7    "updated_at": "2023-03-09T16:22:06.081Z",
8    "channel": "api",
9    "status": {
10      "state": "COMPLETED",
11      "code": "completed",
12      "errors": []
13    },
14    "report": {
15      "id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95",
16      "type": "doc-voi-mortgage",
17      "file_url": "https://api.argyle.com/partners/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/pdf",
18      "json_url": "https://api.argyle.com/partners/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/json"
19    },
20    "employments": [
21      {
22        "employer": "Starbucks",
23        "status": "active",
24        "hire_date": "2015-08-28",
25        "termination_date": null
26      }
27    ],
28    "loan": {
29      "number": "1234",
30      "borrower_id": "ABC789",
31      "application_id": "2121313",
32      "officer_email": "[email protected]"
33    },
34    "billing": {
35      "cost_center": "5"
36    }
37  },
38  {
39    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc3333",
40    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9345",
41    "client": "019a91a4-646c-c82a-9a61-401910b67435",
42    "created_at": "2023-03-10T05:14:06.081Z",
43    "updated_at": "2023-03-10T13:03:06.081Z",
44    "channel": "api",
45    "data_source": "banking",
46    "status": {
47      "state": "PROCESSING",
48      "code": "authenticated",
49      "errors": []
50    },
51    "report": {
52      "id": null,
53      "type": "voai",
54      "from_date": "2024-01-01T00:00:00Z",
55      "income_stream_confidence_minimum": 50,
56      "report_custom_fields": [
57        {
58          "label": "loanID",
59          "value": "12345",
60          "shown": true
61        }
62      ],
63      "file_url": null,
64      "json_url": null
65    },
66    "loan": {
67      "number": "1234",
68      "borrower_id": "ABC789",
69      "application_id": "2121313",
70      "officer_email": "[email protected]"
71    },
72    "billing": {
73      "cost_center": "5"
74    }
75  }
76]

Data Structure

Flows

Management

Reference

POS & LOS Systems

Day 1 Certainty® and AIM

Document Processing

Verification of Income and Employment

Deposit Switching

Paycheck-linked Lending

Getting Started

Argyle Link

Argyle Console

Troubleshooting

Partner Verifications

#The verifications object

Possible values:

Possible values:

Possible values:

Example error

Possible values:

Possible values:

#Order a verification

Possible values:

Possible values:

#Retrieve a verification

#Update a verification

Possible values:

#Cancel a verification

#List all verifications