Verifications Webhooks
Sent when a verification has been updated.
#Updated
post/v2/webhooks
The verifications.updated webhook is sent each time a verification's state transitions to one of the following:
PROCESSINGPAUSEDCOMPLETED
When a verification reaches the COMPLETED state, the report can be retrieved.
Request body
- #eventsarray of stringsrequired
verifications.updated - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
- #configobjectoptional
"include_resource": truewill return the verification object in the response within aresourceobject.
Example Subscription
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["ratings.updated"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'Example Webhook
1{
2 "event": "verifications.updated",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
6 "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
7 "resource": {
8 "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
9 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
10 "created_at": "2023-03-09T16:22:06.081Z",
11 "updated_at": "2023-03-09T16:22:06.081Z",
12 "source": "api",
13 "status": {
14 "state": "COMPLETED",
15 "code": "completed",
16 "errors": []
17 },
18 "report": {
19 "id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95",
20 "type": "doc-voi-mortgage",
21 "file_url": "https://api.argyle.com/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/pdf",
22 "json_url": "https://api.argyle.com/v2/reports/12345678-e321-4a76-8d10-093cfdbb8cdd/json"
23 },
24 "employments": [
25 {
26 "employer": "Starbucks",
27 "status": "active",
28 "hire_date": "2015-08-28",
29 "termination_date": null
30 }
31 ],
32 "loan": {
33 "number": "1234",
34 "borrower_id": "ABC789",
35 "application_id": "2121313",
36 "officer_email": "[email protected]"
37 },
38 "billing": {
39 "cost_center": "5"
40 }
41 }
42 }
43}