Verifications.updated webhook
The verifications.updated webhook is sent when a verification’s status changes.
The verifications.updated webhook is sent for the following status codes:
| Verification state | status.code | Data source |
|---|---|---|
PENDING | invite_sent | Payroll and Banking |
PROCESSING | authenticated | Payroll and Banking |
PROCESSING | documents_processing | Documents |
PROCESSING | report_generating | Payroll |
PROCESSING | awaiting_certification | Payroll |
PAUSED | connection_attempted | Payroll and Banking |
PAUSED | more_data_required | Documents |
PAUSED | syncing_error | Payroll and Banking |
CANCELLED | system_error | Payroll and Banking |
CANCELLED | argyle_timeout | Payroll, Documents, and Banking |
COMPLETED | completed | Payroll, Documents, and Banking |
COMPLETED | completed_with_errors | Payroll, Documents, and Banking |
Set config.include_resource = true to receive the full verification object in the webhook you receive and inspect the status.code.
Authorizations
Username = api_key_id, Password = api_key_secret
Body
verifications.updated
verifications.updated Your name for the webhook subscription.
"name-for-the-webhook-subscription"
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. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.
"https://webhooks.example.com/argyle/verifications-updated"
Optional secret used to verify webhooks.
"secret-value"
"include_resource": true will return the verification object in the response within a resource object.