onKYCSubmit Webhook

✅

Webhook type onKYCSubmit

Scopes

Triggered upon submission of KYC verification.

Note: The webhook url must in a POST method.

Payload

These informations will be sent using the webhook URL:

Field	Type	Description
email	string	The email ID of the Client
reference_id	string	Reference ID number of the Client's KYC
client_reference_id	string	Reference ID number of the client
mode	string	Base message, i.e "KYC Submitted"
group_name	string	Name of the group using which the onboarding process was executed
group_token	string	Group Token number of the Group
created_at	datetime	It contains the on-point date and time

Important

reference_id is generated only when a client initiates KYC verification. If you receive this webhook, it indicates that the client has started the KYC verification process, and the corresponding verification reference_id is provided.
client_reference_id in the webhook payload is a unique identifier assigned when a client is created. This identifier is included in all webhook events.

Request Payload json

{
  "email": "bob.anderson@example.com",
  "kyc_email": "kyc_bob.anderson@example.com",
  "reference_id": "1454346432245-7864",
  "client_reference_id": "1701444864686-9565",
  "mode": "KYC Submitted",
  "group_name": "ABC Corporation",
  "group_token": "8901abcd2345efgh5678",
  "created_at": "2023-05-15 14:20:00"
}

onAction onIdVerificationComplete