Webhooks

Webhooks can be posted back to the default url for the organization as set in Organization Settings.

These are the following types of webhooks that can be sent:

• APPLICANT_CREATED
• APPLICANT_UPDATED
• DOCUMENT_UPLOADED
• BANK_LINKED
• ASSETS_ANALYSED

If there is a non-200 response or no response within 10 seconds from the webhook endpoint, we will retry sending the webhook up to three more times with an exponential backoff in between each retry.

The payload for the webhook is:

{
  "applicant_id": "949f1237-b278-4814-8611-91e1933b82e3",
  "webhook_type": "APPLICANT_UPDATED",
  "timestamp": "2020-04-01T19:50:11.782Z"
}

An applicant update type is fired when any of the following are added or changed by the applicant:

• Profile
• Emails
• Phones
• Addresses
• Identifications
• References
• Employers