Links

Webhook Guide

Webhook

Webhook provides real-time notifications when specific events occur.

Webhook Integration

To integrate webhook, please send your webhook URL to Helpdesk.

Webhook Triggers

"Submission data" only returns entered information. In cases when you do not include any optional information such as "cf1" or "wallet_address" in submission data, the response object does not include them either.

Trigger 1: KYC Pending

KYC submission data is returned when the KYC submission is created and waiting for manual review.
Parameter
Description
email
Email address
created_at
Time when a KYC submission created as 'Pending'
webhook_trigger
submit
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
Sample Response
{
"email":"[email protected]",
"created_at":"2020-08-27T11:47:17.345Z",
"webhook_trigger":"submit",
"submission_id":"1jrho7kecqsonc"
}

Trigger 2: KYC Rejected

KYC submission data is returned when KYC is rejected.
Parameter
Description
kyc_result
KYC result
status
rejected
comment
Detailed reason of KYC rejection
updated_at
Time when KYC is rejected
email
Email address
webhook_trigger
rejected
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
Sample Response
{
"kyc_result": {
"status": "rejected",
"comment": "The entered information does not match with your ID document.",
"updated_at": "2020-06-02T05:19:49.685Z"
},
"email": "[email protected]",
"webhook_trigger": "rejected",
"submission_id": "35sl57karv614s"
}

Trigger 3: KYC Approved

KYC submission data is returned when KYC is approved.
Parameter
Description
kyc_result
KYC result
status
approved
updated_at
Time when KYC is approved
email
Email address
webhook_trigger
approved
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
Sample Response
{
"kyc_result":{
"status":"approved",
"updated_at":"2020-08-27 21:51"
},
"webhook_trigger":"approved",
"email":"[email protected]",
"submission_id":"1jrho7kecqsonc"
}

Trigger 4: AML Screening Completed

AML result and submission data are returned when AML screening is complete.
Parameter
Description
aml_result
AML screening result
currentstatus
Not Screened: no match found in AML database Red Flag : Search result matched with match found in AML database
risk_level_summary
(Not Screened, High, Medium, Low)
webhook_trigger
aml
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
Sample Response
Red Flag
Not Screened
{
"aml_result":{
"currentstatus":"Red Flag",
"risk_level_summary":"HIGH"
},
"webhook_trigger":"aml",
"email":"[email protected]",
"submission_id":"22d4r08kedv2m4d"
}
{
"aml_result":{
"currentstatus":"Not Screened",
"risk_level_summary":"Not Screened"
},
"webhook_trigger":"aml",
"email":"[email protected]",
"submission_id":"1jrho7alsdksonc"
}