Webhook events triggered by a participant onboarding status update.
Platforms leveraging Zero Hash’s customer verification product should subscribe to webhooks to know if participants have completed different portions of the onboarding.
This webhook provides information on whether a participant has completed the different sections of a Zero Hash Participant onboarding via our SDK.
Parameters
Parameter | Description | Type |
---|---|---|
participant_code | The Zero Hash identifier for the new customer. Note: this value is key to enable you to submit trades and check account balances for this customer. | string |
edd_required | Enhanced Due Diligence is required for the Participant and needs to be provided to move forward with onboarding. When this flag is true , the EDD flow must be provided via API or SDK. | boolean |
edd | Whether the participant has provided the required information for an Extensive Due Diligence. The value is true when the information has been provided, otherwise, the value will be false . | boolean |
tax_id | Whether the participant has provided a Tax ID. IF so, value will be true , otherwise, the value will be false . | boolean |
idv | Whether the participant has completed the ID Document verification and the result of such. The different states are pass, fail, not_applicable, unknown . | string |
liveness_check | Whether the participant has completed the Liveness Check and the result of such. The different states are pass, fail, not_applicable, unknown | string |
timestamp | The UNIX timestamp (in milliseconds) representing when the status was changed. | number |
Payload
Participant has provided new information
{
"participant_code": "ABC123",
"edd_required": false,
"edd": true,
"tax_id": true,
"idv": "pass",
"liveness_check": "pass",
"timestamp": 1724767758798
}