Initiate KYC
Initiates the KYC verification process for a tenant.
Asynchronous Operation
This endpoint initiates an asynchronous process. The API response confirms that the KYC flow has been started, while identity verification continues in the background. Completion of the KYC process should be determined using webhook events or iframe events, not by the API response.
KYC completion webhook:
Once KYC verification is completed successfully, a webhook event
KYC_VERIFICATION_DATA is sent.
The webhook payload contains:
event: Event name (KYC_VERIFICATION_DATA)data: KYC verification result data
The configured webhook endpoint must accept POST requests.
Iframe events: When KYC is initiated via iframe, the following events are sent to the parent window:
-
KYC_COMPLETED: On successful KYC completion -
KYC_ERROR: On KYC error or failure -
KYC_USER_EXIT: If the user exits the KYC flow