Skip to main content
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "verifications.updated"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://webhooks.example.com/argyle/verifications-updated",
  "secret": "secret-value",
  "config": {
    "include_resource": true
  }
}
'
{
  "event": "verifications.updated",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
    "resource": {
      "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": "www.argyle.com/storagename/pdf",
        "json_url": "www.argyle.com/storagename/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"
      },
      "data_source": "documents"
    }
  }
}
Sent when a verification has been updated.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
enum<string>[]
required

verifications.updated

Available options:
verifications.updated
​
name
string
required

Your name for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

​
url
string
required

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.

Example:

"https://webhooks.example.com/argyle/verifications-updated"

​
secret
string

Optional secret used to verify webhooks.

Example:

"secret-value"

​
config
object

"include_resource": true will return the verification object in the response within a resource object.

Example:
{ "include_resource": true }

Response

200 - application/json
​
event
string

verifications.updated

​
name
string

Name used for the webhook subscription.

​
data
object