{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "onboarding-document.status-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Onboarding document status changed
Triggered when an onboarding document changes status: an upload completed (NOT_VALIDATED), a newer
document replaced it (SUPERSEDED), complete found the same bytes already stored and closed the
document you had opened (PENDING_UPLOAD → SUPERSEDED, superseded_by_id the document that holds
them), Rinne closed an upload whose URL expired with nothing received (PENDING_UPLOAD → SUPERSEDED,
superseded_by_id null), an affiliation that sent it was approved (NOT_VALIDATED or REJECTED → VALIDATED),
or a document another organization validated was shared into the company (VALIDATED, with
old_status null). payload.entity is the document as
GET /v1/onboarding-documents/{id} returns it, without the download URL. Sent to the company the document
was presented for and, when that company is a merchant, to its organization.
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "onboarding-document.status-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Body
Base structure for all webhook events
Unique event identifier
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Event type identifier
onboarding-document.status-changed "onboarding-document.status-changed"
Event schema version
1
Event timestamp in ISO 8601 format
"2025-01-15T10:30:00.000Z"
Service that generated the event
"transaction-service"
Company ID associated with the event
"comp_123456789"
Shared by every event that one request, inbound webhook or job item caused, so related events can be grouped. Not unique per event: use id to identify and deduplicate an event.
"corr_987654321"
Onboarding document status change details
Show child attributes
Show child attributes
Response
Webhook received successfully