Skip to main content
WEBHOOK

Event Types

The data object mirrors the shape of the Retrieve Account API response.

Body

application/json
event_id
string<uuid>
required

A unique identifier for this event.

event_name
enum<string>
required

Top-level event category.

Available options:
ONBOARDING
event_type
enum<string>
required

The specific event type that occurred.

Available options:
onboarding.account.create,
onboarding.account.update
source_id
string
required

Account ID.

version
string
required

API version number.

Example:

"V1.6.0"

data
object

Account details associated with the event. Shape mirrors the response of the Retrieve Account API, with one caveat: on the onboarding.account.update event, document URLs and representative-level internal fields (documents, other_documents, representative_id, email_address, idv_status) are typically omitted because the update payload reflects the compliance-reviewed state rather than the applicant-submitted profile.

Response

200

Return 200 to acknowledge receipt.