CustomerIdDocumentAdded

Description

A webhook event is sent when a document added by a client for verification is available for downloading. This allows you to retrieve and store copies of the identity documents, selfies, or proof of address documents provided by the customer.

Payload Examples

Identity Document

{
    "eventId": "62037b42-0f8c-476f-be40-8a263ea71347",
    "eventType": "CustomerIdDocumentAdded",
    "eventTimestamp": "2025-12-30T08:32:44.7751406Z",
    "customerId": "db0bd3fd-2ac6-4887-bad3-8a305a3d6892",
    "customerExternalId": "abc123",
    "idDocId": "2115305",
    "idDocSetType": "IdentityDocument",
    "idDocType": "InternationalPassport",
    "idDocSubType": "FrontSide"
}

Digital Selfie

{
    "eventId": "05375f8e-6173-4db1-9c53-09e4593ff4c8",
    "eventType": "CustomerIdDocumentAdded",
    "eventTimestamp": "2025-12-30T08:32:44.648615Z",
    "customerId": "db0bd3fd-2ac6-4887-bad3-8a305a3d6892",
    "customerExternalId": "abc123",
    "idDocId": "2115304",
    "idDocSetType": "IdentityDocument",
    "idDocType": "Selfie",
    "idDocSubType": "Selfie"
}

Field Descriptions

Field	Type	Description
`eventId`	string (UUID)	Unique identifier for the webhook event.
`eventType`	string	The type of event, always `CustomerIdDocumentAdded` for this webhook.
`eventTimestamp`	string (ISO 8601)	The time when the event occurred.
`customerId`	string (UUID)	The unique identifier of the customer in the Altery system.
`customerExternalId`	string \| null	The optional customer identifier provided by you during creation.
`idDocId`	string	The unique identifier for the document.
`idDocSetType`	string	The category of the document set (e.g., `IdentityDocument`, `Address`).
`idDocType`	string	The specific document type (e.g., `InternationalPassport`, `Selfie`, `UtilityBill`).
`idDocSubType`	string	The document sub-type or side (e.g., `FrontSide`, `BackSide`, `Selfie`).