Events
This article lists the Webhooks you may receive when regarding user verification.
KYC
user.kycrequest
This event is useful when your users request the validation themselves.
json
{
"messageId": "04b61286-2cb1-555c-a62e-49836482c5b8",
"webhookId": "fd895029-22e5-49ed-a2c8-093c07dc053c",
"webhook": {
"webhook": "user.kycrequest",
"object": "user",
"object_id": "6461762",
"object_payload": {
"users": [
{
"userId": "6461762",
"userTypeId": "1",
"userStatus": "VALIDATED",
"clientId": "516899",
"userTag": "",
"parentUserId": null,
"parentType": null,
"title": "M",
"firstname": "Alex",
"lastname": "Oak",
"middleNames": "",
"birthday": "1989-00-00",
"email": "a.oak@example.com",
"address1": "12 Willow Lane",
"address2": "",
"address3": "",
"postcode": "75000",
"city": "Paris",
"state": "Paris",
"country": "FR",
"countryName": "France",
"phone": "+xxxxxxxxxxxxx",
"mobile": "+xxxxxxxxxxxxx",
"nationality": "FR",
"nationalityOther": "",
"placeOfBirth": "Caen",
"birthCountry": "FR",
"occupation": "",
"incomeRange": "28-35",
"legalName": "",
"legalNameEmbossed": "",
"legalRegistrationNumber": "",
"legalTvaNumber": "",
"legalRegistrationDate": "0000-00-00",
"legalForm": "",
"legalShareCapital": "0",
"legalSector": "",
"legalAnnualTurnOver": "",
"legalNetIncomeRange": "",
"legalNumberOfEmployeeRange": "",
"effectiveBeneficiary": "0.00",
"position": "",
"personalAssets": "0-2",
"taxResidence": "FR",
"taxNumber": "",
"kycLevel": "0",
"kycReview": "1",
"kycReviewComment": "",
"isFreezed": "0",
"language": null,
"specifiedUSPerson": "0",
"employeeType": "0",
"entityType": "0",
"controllingPersonType": "0",
"activityOutsideEu": null,
"economicSanctions": null,
"residentCountriesSanctions": null,
"involvedSanctions": null,
"entitySanctionsQuestionnaire": null,
"sanctionsQuestionnaireDate": null,
"timezone": null,
"createdDate": "2022-05-18 12:21:04",
"modifiedDate": "2022-05-18 12:21:12",
"codeStatus": "110009",
"informationStatus": "",
"sepaCreditorIdentifier": null,
"walletCount": "1",
"payinCount": "0",
"totalRows": "1"
}
]
},
"webhook_created_at": 16532945786168,
"webhook_id": "fd895029-22e5-49ed-a2c8-093c07dc053c",
"object_payload_signature": "pVzBUAM2mgVtCNxw6u4fdaZqktAlStk\/yGlfA1v2JQs="
},
"clientId": "516899"
}user.kycreview
This event is sent when our team validates or refuses a User.
json
{
"messageId": "db99d40f-0840-5945-bfab-8f01daf65ac1",
"webhookId": "8f3577ec-c126-4e94-a3df-1bdccfb0b89f",
"webhook": {
"webhook": "user.kycreview",
"object": "user",
"object_id": "6461762",
"object_payload": {
"users": [
{
"userId": "6461762",
"userTypeId": "1",
"userStatus": "VALIDATED",
"clientId": "516899",
"userTag": "",
"parentUserId": null,
"parentType": null,
"title": "M",
"firstname": "Alex",
"lastname": "Oak",
"middleNames": "",
"birthday": "1989-00-00",
"email": "a.oak@example.com",
"address1": "xxxxxxxxxxx",
"address2": "",
"address3": "",
"postcode": "75000",
"city": "Paris",
"state": "Paris",
"country": "FR",
"countryName": "France",
"phone": "+00000000000",
"mobile": "+00000000000",
"nationality": "FR",
"nationalityOther": "",
"placeOfBirth": "Caen",
"birthCountry": "FR",
"occupation": "",
"incomeRange": "28-35",
"legalName": "",
"legalNameEmbossed": "",
"legalRegistrationNumber": "",
"legalTvaNumber": "",
"legalRegistrationDate": "0000-00-00",
"legalForm": "",
"legalShareCapital": "0",
"legalSector": "",
"legalAnnualTurnOver": "",
"legalNetIncomeRange": "",
"legalNumberOfEmployeeRange": "",
"effectiveBeneficiary": "0.00",
"position": "",
"personalAssets": "0-2",
"taxResidence": "FR",
"taxNumber": "",
"kycLevel": "2",
"kycReview": "2",
"kycReviewComment": "30-05-2022 - 16:11:02Level : REGULAR et Review : VALIDATED",
"isFreezed": "0",
"language": null,
"specifiedUSPerson": "0",
"employeeType": "0",
"entityType": "0",
"controllingPersonType": "0",
"activityOutsideEu": null,
"economicSanctions": null,
"residentCountriesSanctions": null,
"involvedSanctions": null,
"entitySanctionsQuestionnaire": null,
"sanctionsQuestionnaireDate": null,
"timezone": null,
"createdDate": "2022-05-18 12:21:04",
"modifiedDate": "2022-05-18 12:21:12",
"codeStatus": "110009",
"informationStatus": "",
"sepaCreditorIdentifier": null,
"walletCount": "1",
"payinCount": "0",
"totalRows": "1"
}
]
},
"webhook_created_at": 16539198620721,
"webhook_id": "8f3577ec-c126-4e94-a3df-1bdccfb0b89f",
"object_payload_signature": "Kg\/+Np3zU7vW9f6HbMCU0ueIIACCRfGKCiWa+PiLvzM="
},
"clientId": "516899"
}Documents
document.create
json
{
"webhook": "document.create",
"webhook_id": "10XXXXXX",
"object": "document",
"object_id": "8XXXX",
"object_payload": {
"documents": [
{
"documentId": "8XXXX",
"documentTag": "LP'6C7`VGnREXXXXXXXX",
"clientId": "4XXXX",
"userId": "1XXXXXX",
"userFirstname": "Victoria",
"userLastname": "Perin",
"name": "Merged_Passport.pdf",
"documentStatus": "PENDING",
"documentTypeId": "17",
"documentType": "PASSPORT",
"fileName": "8XXXX.pdf",
"thumbFileName": "",
"createdDate": "2020-05-19 10:34:21",
"modifiedDate": "0000-00-00 00:00:00",
"codeStatus": "600003",
"informationStatus": "",
"residenceId": "0"
}
]
},
"object_payload_signature": "bJaKKq6y4Ah5RhlZMIgHwClWMxGIxpBB4xdMJXddXXXX"
}document.update
json
{
"webhook": "document.update",
"webhook_id": "1XXXXXXX",
"object": "document",
"object_id": "8XXXX",
"object_payload": {
"documents": [
{
"documentId": "8XXXX",
"documentTag": "draftedstatutes",
"clientId": "9XXXX",
"userId": "1XXXXXX",
"userFirstname": "MICHELE",
"userLastname": "CRESSIN",
"name": "draftedstatutes_2192.pdf",
"documentStatus": "PENDING",
"documentTypeId": "23",
"documentType": "LEGAL_STATUS",
"fileName": "80009.pdf",
"thumbFileName": "",
"createdDate": "2020-05-13 16:22:03",
"modifiedDate": "2020-05-13 18:28:43",
"codeStatus": "600003",
"informationStatus": "",
"residenceId": "0"
}
]
},
"object_payload_signature": "q53Gk3QsSuOurHDECo9CZZ4cs9GRMg8I81L21M6+XOXO"
}You can check the list of codeStatus in the Documents article.
document.cancel
json
{
"webhook": "document.cancel",
"webhook_id": "1XXXXXX",
"object": "document",
"object_id": "8XXXX",
"object_payload": {
"documents": [
{
"documentId": "8XXXX",
"documentTag": "0000000",
"clientId": "1XXXXX",
"userId": "0000000",
"userFirstname": "Marie",
"userLastname": "bela",
"name": "XXXXXX_doc",
"documentStatus": "CANCELED",
"documentTypeId": "21",
"documentType": "PAYSLIP",
"fileName": "AAAAA.jpg",
"thumbFileName": "",
"createdDate": "2020-05-18 22:55:13",
"modifiedDate": "2020-05-18 20:55:24",
"codeStatus": "600004",
"informationStatus": "",
"residenceId": "0"
}
]
},
"object_payload_signature": "OfyL8/fpm1FX33ubIWdPqG+bNsQlhCFm4yN0Zl8XXXXX"
}KYC Liveness
The following webhooks are sent for Live Verification (whether it is Liveness or Certified video).
kycliveness.create
json
{
"webhook":"kycliveness.create",
"webhook_id":"42424224-442z5-42ce9-8242-513d80c15142",
"object":"identification",
"object_id":"9dac1414-6733-46ae-b5a9-1b3aa39ea4bd",
"object_payload":{
"kyc-status": "processing",
"comment": "Some additional elements need to be verified. You will be notified by webhook when the final answer is ready.",
"user_id":"2440234",
"started-at": "2020-06-30T07:10:47.824723Z",
"updated-at": "2020-06-30T07:15:18.856843Z",
"score": 1,
"identity": {
"last-name": "OAK",
"first-name": "ALEX",
"birth-date": "1942-11-19",
"gender": "M",
"issuing-place": "",
"birthplace": "PARIS"
},
},
"object_payload_signature":"5Hfi\/ywu2fjtw0Exm22rJJwyZEej4Qp4BfPsamXAP\/42"
}kycliveness.update
json
{
"webhook":"kycliveness.update",
"webhook_id":"42424224-442z5-42ce9-8242-513d80c11111",
"object":"identification",
"object_id":"9dac1414-6733-46ae-b5a9-1b3aa39ea4xx",
"object_payload":{
"updated-at": "2024-03-08T05:37:26.076003Z",
"started-at": "2024-03-08T05:32:37.100594Z",
"identity": {
"last-name": "OAK",
"first-name": "ALEX",
"birth-date": "1990-07-18",
"gender": "M",
"issuing-place": "",
"birthplace": "PARIS"
},
"kyc-status": "processed",
"comment": "Applicant did not show the full front view of their face, Applicant performed their id verification under poor lighting conditions, Applicant's identity does not match with the expected one",
"refusal-details": {
"meta": {
"count": 3
},
"reasons": [
{
"reason-code": "1312",
"reason-message": "Applicant did not show the full front view of their face"
},
{
"reason-code": "1320",
"reason-message": "Applicant performed their id verification under poor lighting conditions"
},
{
"reason-code": "2401",
"reason-message": "Applicant's identity does not match with the expected one"
}
]
},
"user_id": "100196123",
"score": 0
},
"object_payload_signature":"5Hfi\/ywu2fjtw0Exm22rJJwyZEej4Qp4BfPxxxXXX\/42"
}Qualified eSignature
The following webhooks are sent for qualified electronic signature (QES) verification.
qes.created
json
{
"webhook": "qes.created",
"object_payload": {
"userId": "4137216",
"result": "STARTED",
"identificationTime": "",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP"
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194724399022,
"webhook_id": "af5a6c9e-4dc8-4d58-a245-e26dc27xx9aa",
"object_payload_signature": "WUuvXuGyAL4dw9C12K3HxxRmUi3hMxxy8+4kMaRhLDo="
}qes.processing
json
{
"webhook": "qes.processing",
"object_payload": {
"userId": "4137216",
"result": "CHECK_PENDING",
"identificationTime": "2024-06-27T09:16:23+02:00",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP"
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194725841286,
"webhook_id": "5fa78cf6-c85b-46c2-b950-a7ad7e974291",
"object_payload_signature": "WDeMRi95hkJhllJZBwfhc2xxRdF1aymVcDhybMzDsig="
}qes.aborted
json
{
"webhook": "qes.aborted",
"object_payload": {
"userId": "100438239",
"result": "ABORTED",
"identificationTime": "2024-06-15T10:58:02+02:00",
"identId": "TST-ARJBA",
"transactionNumber": "3606323f-345e-5105-bfb6-7ca324a69945",
"type": "APP",
"reason": {
"reasonDetails": {
"reasonCode": "3002",
"reasonMessage": "USER_CANCELLATION_DOCUMENT_EXPIRED"
}
}
},
"object_id": "3606323f-345e-5105-bfb6-7ca324a69945",
"object": "identification",
"webhook_created_at": 17184418842212,
"webhook_id": "696b7f9e-020b-4b60-b91a-c7fab0a4940f",
"object_payload_signature": "yNd+4XWx6bIeJn1/lzWliCb//Vwl8BkxxJ4y3+qwL4E="
}qes.finalized
The structure of the webhook differs depending on its result.
json
{
"webhook": "qes.finalized",
"object_payload": {
"userId": "4137216",
"result": "SUCCESS_DATA_CHANGED",
"identificationTime": "2024-06-27T09:16:23+02:00",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP",
"identity": {
"firstname": "ALEX",
"lastname": "OAK",
"birthday": "1983-08-12",
"gender": "OTHER",
"issuingPlace": "STADT KÖLN",
"birthplace": "BERLIN"
}
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194726044907,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02c3d43eb8",
"object_payload_signature": "svoHId/5xu940i24cJV82+nCYnzUDv4a9cxxAj9GvJo="
}json
{
"webhook": "qes.finalized",
"object_payload": {
"userId": "4137216",
"result": "CANCELED",
"identificationTime": "2024-06-27T09:16:23+02:00",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP",
"identity": {
"firstname": "ALEX",
"lastname": "OAK",
"birthday": "1983-08-12",
"gender": "OTHER",
"issuingPlace": "STADT KÖLN",
"birthplace": "BERLIN"
},
"reason": {
"reasonDetails": {
"reasonCode": "3201",
"reasonMessage": "WARNING_SELFIE_REAL_PERSON"
}
}
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194726044907,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02c3d43eb8",
"object_payload_signature": "svoHId/5xu940ixxcJV82+nCYnzUDv4a9cmYAj9GvJo="
}Video Conference
The following webhooks are sent for video conference verification.
videoConference.created
json
{
"webhook": "videoConference.created",
"object_payload": {
"userId": "4137216",
"result": "STARTED",
"identificationTime": "",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP"
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194724399022,
"webhook_id": "af5a6c9e-4dc8-4d58-a245-e26dc27xx9aa",
"object_payload_signature": "WUuvXuGyAL4dw9C12K3HxxRmUi3hMxxy8+4kMaRhLDo="
}videoConference.processing
json
{
"webhook": "videoConference.processing",
"object_payload": {
"userId": "100764422",
"result": "REVIEW_PENDING",
"identificationTime": "2024-08-27T15:23:03+02:00",
"identId": "TS2-FEJYN",
"transactionNumber": "bd17f3e1-05fe-5b12-929c-0d4b9b27c4a2",
"type": "WEB"
},
"object_id": "bd17f3e1-05fe-5b12-929c-0d4bxxxc4a",
"object": "identification",
"webhook_created_at": 1724061955000,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02cxxx3eb8",
"object_payload_signature": "svoHId/5xu940i24cJV82+nCYnzUDxxx9cxxAj9GvJo="
}videoConference.aborted
json
{
"webhook": "videoConference.aborted",
"object_payload": {
"userId": "4137216",
"result": "ABORTED",
"identificationTime": "2024-08-01T01:33:00+02:00",
"identId": "TS2-KWYGX",
"transactionNumber": "26dd014c-33f2-56f6-9ebc-bec12caxx2bf",
"type": "WEB",
"reason": {
"reasonDetails": { "reasonCode": "", "reasonMessage": "STALLED_TIMEOUT" }
}
},
"object_id": "26dd014c-33f2-56f6-9ebc-bec1xxa162bf",
"object": "identification",
"webhook_created_at": 1724061955000,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02c3xx3eb8",
"object_payload_signature": "svoHId/5xu940i24cJV82+nCYnzxx4a9cxxAj9GvJo="
}videoConference.finalized
The structure of the webhook differs depending on its result.
json
{
"webhook": "videoConference.finalized",
"object_payload": {
"userId": "100689821",
"result": "SUCCESS_DATA_CHANGED",
"identificationTime": "2024-08-19T10:05:55+02:00",
"identId": "TS2-HGWTV",
"transactionNumber": "11a08a9a-b05a-5127-b727-b32fa01616bc",
"type": "WEB",
"identity": {
"firstname": "ALEX",
"lastname": "OAK",
"birthday": "1983-10-30",
"gender": "F",
"issuingPlace": "ISSUER",
"birthplace": "BIRTHPLACE"
}
},
"object_id": "11a08a9a-b05a-5127-b727-b32fxxx16bc",
"object": "identification",
"webhook_created_at": 1724061955000,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02cxx3eb8",
"object_payload_signature": "svoHId/5xu940i24cJV82+nCYnzUDv4a9cxxx9GvJo="
}json
{
"webhook": "videoConference.finalized",
"object_payload": {
"userId": "4137216",
"result": "CANCELED",
"identificationTime": "2024-06-27T09:16:23+02:00",
"identId": "TST-TWLYB",
"transactionNumber": "b00ecdec-b721-55c4-8e20-ef3625616926",
"type": "APP",
"identity": {
"firstname": "ALEX",
"lastname": "OAK",
"birthday": "1983-08-12",
"gender": "OTHER",
"birthplace": "BERLIN"
},
"reason": {
"reasonDetails": {
"reasonCode": "3201",
"reasonMessage": "WARNING_SELFIE_REAL_PERSON"
}
}
},
"object_id": "b00ecdec-b721-55c4-8e20-ef3625616926",
"object": "identification",
"webhook_created_at": 17194726044907,
"webhook_id": "8a7dfe6b-d44a-4b54-92a7-cc02c3d43eb8",
"object_payload_signature": "svoHId/5xu940ixxcJV82+nCYnzUDv4a9cmYAj9GvJo="
}