Skip to main content

Events

This section covers the supported event types, and how to interpret event-specific data.

Application Events​

Application events notify you of changes in the status of an application, typically related to user identity or document verification. The following events are supported:

  • application.created: Triggered when a new application is created and shared with a project.
  • application.approved: Indicates that the application has been approved.
  • application.rejected: Indicates that the application has been rejected, and it may not be resubmitted.
  • application.submitted: Triggered when the user provides additional information, updating the application.
  • application.retry_required: Indicates that a document was rejected and requires re-submission.

Event Data​

Each application event has the following data structure:

{
  "data": {
    "application_id": "00000000-0000-0000-0000-000000000000" // Unique identifier for the application
  }
}

Example full payload:

{
  "idempotency_key": "00000000-0000-0000-0000-000000000000",
  "type": "application.approved",
  "created_at": "2024-11-06T08:38:49.867Z",
  "data": {
    "application_id": "00000000-0000-0000-0000-000000000000"
  }
}
  • application_id: The unique ID of the application. This allows you to look up or update the corresponding record in your system.

Adding New Event Types​

The platform may add new fields or event types over time. To ensure compatibility, your webhook handler should ignore any unexpected fields, and gracefully handle any unknown event types by logging them or discarding them as appropriate. This way, your integration remains stable and can adapt to updates in the webhook system.