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.
KYC Status Change
If webhook_trigger is one of [approved, rejected, updated], the three additional parameters below are returned.
However, this only applies if the relevant data exists in the submission data. (gender, date_of_birth, nationality)
AML Results
AML result and submission data are returned when AML screening is completed , no screening for rejected KYCs. AML Screening is performed only when KYC is approved and the results are returned.
Copy {
"webhook_trigger" : "aml" ,
"submission_id" : "string" ,
"email" : "sample@test.com" ,
"userid" : "test" ,
"cf" : {
"cf1" : "cf1" ,
"cf2" : "cf2" ,
"cf3" : "cf3"
} ,
"aml_result" : {
"currentstatus" : "Not Screened" ,
"risk_level_summary" : "Not Screened"
} ,
"tokenId" : "test"
}
Approved
Example
Copy
{
"webhook_trigger" : "approved" ,
"kyc_result" : {
"status" : "string" ,
"updated_at" : "string" ,
"created_at" : "string" ,
"kyc_result_at" : "string" ,
"pending_at" : "string" ,
"reviewer" : "string"
} ,
"applicant_id" : "string" ,
"submission_id" : "string" ,
"email" : "string" ,
"tokenId" : "string" ,
"cf" : {
"cf1" : "string" ,
"cf2" : "string" ,
"cf3" : "string"
} ,
"userid" : "string" ,
"age_group" : "string" ,
"gender" : "string" ,
"date_of_birth" : "string" ,
"nationality" : "string" ,
"ipAddress" : "string" ,
"fullName" : "string" ,
"idType" : "string" ,
"issuingCountry" : "string" ,
"issueDate" : "string" ,
"expireDate" : "string" ,
"identityNumber" : "string" ,
"documentNumber" : "string" ,
"additional_list" : {
"answer" : "string" ,
"inputValue" : "string" ,
"blockType" : "string"
}
}
Rejected
Example
Copy {
"webhook_trigger" : "rejected" ,
"kyc_result" : {
"status" : "string" ,
"comment" : "string" ,
"updated_at" : "string" ,
"commentCode" : "string"
} ,
"submission_id" : "string" ,
"applicant_id" : "string" ,
"email" : "string" ,
"cf" : {
"cf1" : "string" ,
"cf2" : "string" ,
"cf3" : "string"
} ,
"userid" : "string" ,
"tokenId" : "string" ,
"ipAddress" : "string"
}
Updated
Example
Copy {
"webhook_trigger" : "updated" ,
"submission_id" : "string" ,
"email" : "test@argosidentity.com" ,
"data" :
{
"update" :
[
"idType" ,
"issuingCountry" ,
"fullName" ,
"gender" ,
"birthDate" ,
"nationality" ,
"kycStatus" ,
"issueDate" ,
"identityNumber"
] ,
"kyc_result" : "rejected"
} ,
"admin" : "sample@test.com" ,
"update_time" : "2024-06-21T01:47:12.321Z" ,
"age_group" : "N/A" ,
"gender" : "female" ,
"date_of_birth" : "1999-10-19" ,
"nationality" : "KOR" ,
"userid" : "test" ,
"tokenId" : "test"
}
Submit
Example
Copy {
"webhook_trigger" : "submit" ,
"created_at" : "string" ,
"submission_id" : "string" ,
"email" : "string" ,
"cf" : {
"cf1" : "string" ,
"cf2" : "string" ,
"cf3" : "string"
} ,
"userid" : "string" ,
"tokenid" : "string" ,
"ipAddress" : "string"
}
Delete
Example
Copy {
"webhook_trigger" : "delete" ,
"submission_id" : "string" ,
"account_email" : "sample@test.com" ,
"delete_time" : "2024-06-21T01:54:47.481Z" ,
"comment" : "test"
}
Injection
Example
Copy {
"webhook_trigger" : "injection" ,
"action" : {
"type" : "address" ,
"created_at" : "2024-06-21T03:24:57.565Z"
} ,
"submission_id" : "string" ,
"email" : "sample@test.com" ,
"kyc_status" : "approved" ,
"applicant_id" : "string" ,
"cf1" : "cf1" ,
"cf2" : "cf2" ,
"cf3" : "cf3" ,
"userid" : "test" ,
"tokenId" : "test"
}
Sample Data
submit
Copy {
uri: 'https://your-endPoint-url.com',
method: 'POST',
body: {
webhook_trigger:"submit",
kyc_result:{
status:"rejected",
created_at:"2023-07-06T02:01:03.494Z"
},
submission_id:"{submissionId}",
projectId:"{projectId}",
email:"test@sample.com",
userid:"{userid}"
},
json: true
}
approved
Copy {
uri: 'https://your-endPoint-url.com',
method: 'POST',
body: {
webhook_trigger:"approved",
kyc_result:{
status:"rejected",
comment:"Multiple invalid KYC attempts"
updated_at:"2023-07-06T00:45:05.738Z"
},
submission_id:"{submissionId}",
projectId:"{projectId}",
email:"test@sample.com",
userid:"{userid}"
},
json: true
}
rejected
Copy {
uri: 'https://your-endPoint-url.com',
method: 'POST',
body: {
webhook_trigger:"approved",
kyc_result:{
status:"rejected",
comment:"Multiple invalid KYC attempts"
updated_at:"2023-07-06T00:45:05.738Z"
},
submission_id:"{submissionId}",
projectId:"{projectId}",
email:"test@sample.com",
userid:"{userid}"
},
json: true
}
updated
Copy {
uri: 'https://your-endPoint-url.com',
method: 'POST',
body: {
kyc_result: { status: 'approved', updated_at: '2023-07-11T09:13:24.751Z' },
email: 'test@sample.com',
webhook_trigger: 'updated',
submission_id: 'test_submissions_id',
userid:{userid}
},
json: true
}
aml
Copy {
uri: 'https://your-endPoint-url.com',
method: 'POST',
body: {
webhook_trigger: 'aml',
submission_id: '{submissionId}',
email: 'test@sample.com',
userid:{userid}
aml_result: {
currentstatus: 'Not Screened',
risk_level_summary: 'Not Screened'
}
},
json: true
}
Delete
Copy {
uri: 'https://your-endPoint-url.com',
method: 'DEL',
body: {
webhook_trigger:"delete",
submission_id:"{submissionId}",
account email:"test@sample.com",
delete_time:"2024-05-03T02:01:03.494Z"
},
json: true
}
Injection
Copy {
uri: 'https://your-endPoint-url.com',
method: 'PUT',
body: {
webhook_trigger:"injection",
action:{
type:"address",
created_at:"2024-05-03T02:01:03.494Z"
},
submission_id:"{submissionId}",
email:"test@sample.com",
userid:"{userid}"
},
json: true
}
1. Bidirectional Encryption/Decryption for Output Data
When using the encryption option, both input and output require bidirectional encryption/decryption.
Output:
Return the encrypted result in the body
.
Example:
Copy response : {
...
body : "encrypted-string"
}