Webhooks
The "KYB Webhooks" feature ensures seamless integration between the KYB platform and your applications, automating real-time updates on the status of your service requests. By configuring your designated webhook URL in the back office settings, you enable immediate notifications sent to the specified URL upon any service request. This eliminates the need for manual status checks, enhancing workflow efficiency and providing a cohesive user experience.
To take advantage of this powerful feature, follow the simple steps:
- Go to this URL https://backoffice.thekyb.com
- Click on your profile section
- Open the Settings Page
- Navigate to the Webhook tab
- Add the Webhook URL (Request method must be POST)
Webhook Status
The status in our webhook responses provides crucial information about the state of your service requests. Below are the possible status values and their description:
| Parameter | Description |
|---|---|
| pending | The service request is currently being processed. This status indicates that the request is underway, and the final result will be provided once the process is complete. |
| resolved | The service request has been completed. This status indicates that the final results are now available. |
Services Webhooks
The following section provide detailed information on the payload structure for each service webhook. By understanding the payload structure, you can effectively integrate and handle the data provided by these webhooks.
Business Information
The Business Information webhook has following events:
1. Service Initiated
Payload:
{
"kyb_backoffice_id": "kyb-3nGsq1717871",
"service_id": "667ab56f0e4e6520880",
"questionnaire_request_id": "667ab56f0b4e652088",
"type": "service_initiated",
"url_token": "2Uh806iFSrNRsUZxaTCOJLgbtaVLEzi62Laq9AfjedKX2axaUGaGCvIJhJPBQV9siA5e0mSLxVhBJ9KnIJ7VkBnUBQnbWSNsk1719317",
"status": "pending",
"services": [
"questionnaire",
"kyc"
],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e429f39fac6df401f&service_id=667ab56f0e4e6520880"
}
2. Service Resolved
Payload:
{
"kyb_backoffice_id": "kyb-PlJMD1715907",
"service_id": "667a5fa30e5310c084",
"questionnaire_request_id": "667a5fa40e1310c084",
"status": "resolved",
"type": "service_resolved",
"kyb_request_from": "backoffice",
"services": [
"questionnaire",
"kyb_check",
"document_base_kyb"
],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e42983f39c6df401f&service_id=667a5fa30e5310c084"
}
KYB Check
The KYB Check webhook has following event:
1. Service Resolved
Payload:
{
"kyb_backoffice_id": "kyb-oidaw19331394",
"service_id": "667aea42a35c3e7027",
"status": "resolved",
"type": "service_resolved",
"search": "shufti pro",
"search_type": "contains",
"kyb_request_from": "backoffice",
"services": [
"kyb_check"
],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e429839fac6df401f&service_id=667aea425c3e1d87027",
"kyb_request_id": "667aea43ed80476d0009b"
}
Document Base KYB
The Document Base KYB webhook has following events:
1. Service Initiated
Payload:
{
"kyb_backoffice_id": "kyb-AGWLO1719452",
"service_id": "667c07eb4fca3a501e",
"questionnaire_request_id": "667c07eb4f00b3a50",
"type": "service_initiated",
"url_token": "S26EkfRUtEWLyw2ZLnabIUvp6Wihvw3fUjeC8XMA4FDQtCXoFy0wu8b1SrugAJLnfdUHKouJ5pGraYtGiRpSYftT2EaLgxNe",
"status": "pending",
"services": [
"document_base_kyb"
],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65b8ff12e583c4364&service_id=667c07eb4fca00b3a"
}
2. Service Resolved
Payload:
{
"kyb_backoffice_id": "kyb-jbVmB193170",
"service_id": "667ab229609e648f034",
"status": "resolved",
"type": "service_resolved",
"search": "Bicod Group Aw",
"search_type": "contains",
"kyb_request_from": "backoffice",
"services": ["document_base_kyb"],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e42983f39f6df401f&service_id=667ab229ea9e648f034",
"aml_request_id": "667ab230c4679310500",
"kyb_request_id": "667ab230c46b7931050"
}
AML Screening
The AML Screening webhook has following event:
1. Service Resolved
Payload:
{
"kyb_backoffice_id": "kyb-ziLTg19296144",
"service_id": "667a60903a90f2f305",
"aml_request_id": "667a6091833fe79207",
"search": "John Doe",
"status": "resolved",
"type": "service_resolved",
"kyb_request_from": "backoffice",
"services": ["aml"],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e42983f39fadf401f&service_id=667a609a90f244f3055"
}
Know Your Customer (KYC)
The Know Your Customer (KYC) webhook has following event:
1. Service Resolved
Payload:
{
"kyb_backoffice_id": "kyb-0Q3Gz17259750",
"service_id": "666a90265eae0466097",
"kyc_request_id": "666a9028ab680890d9",
"status": "resolved",
"type": "service_resolved",
"kyb_request_from": "backoffice",
"services": ["kyc"],
"link": "https://backoffice.thekyb.com/cases-detail?company_id=65e42983f39fac6df401f&service_id=666a90265eae04c466097"
}
Paid Documents Extraction
The Paid Documents Extraction webhook has following event:
1. Document Purchase Request
Payload:
{
"document_name": "company report",
"kyb_backoffice_id": "kyb-4wTbm1719300",
"service_id": "667a719da9d26cc974",
"kyb_request_id": "667a719ed57ae3a192",
"search": "ferrari n.v.",
"registration_number": "64060977",
"status": "resolved",
"type": "document_purchase_request",
"kyb_request_from": null,
"services": ["documents"],
"link": "https://api.thekyb.com/api/getFile/667a72a171b90e6?download=true",
"document_found": true,
"description": "Your Requested Document, 'company report' in Italy for Company 'Ferrari N.v.' is now ready."
"uid": "0a2cf4bc21912d719a66c9b345416",
"document_request_id": "66fbb985060ed120c20de"
}
Ongoing AML
The Ongoing AML webhook has following event:
1. Ongoing AML
Payload:
{
"kyb_backoffice_id": "kyb-ZHALX1723184797",
"service_id": "66b5b69d4c3ef468c7002f7",
"aml_request_id": "66b5b6a103db7af8080bfa6",
"search": "john doe holdings limited",
"status": "resolved",
"type": "ongoing_aml_webhook",
"kyb_request_from": "backoffice",
"services": [
"kyb_check",
"aml_for_company",
"aml_for_people"
],
"link": "https://backoffice.thekyb.com/aml-result?request_id=66b5b6a103db7af8080bfa6"
}