This section lists a collection of webhooks that you may receive during transaction monitoring .
Webhook Description applicantKytTxnApproved The transaction was approved and the transfer or deposition of assets/properties can be expected soon. applicantKytTxnRejected The checks have been completed and the review result is — rejected . applicantKytTxnReviewed The transaction that was previously put on hold was reviewed by the officer and removed from the on-hold queue. You can soon expect the webhook to note you on the review results. applicantKytTxnDeleted The transaction and all the related information were deleted. applicantKytOnHold Based on the rules you applied , the transaction was put on hold and queued for manual review by the dedicated expert. As soon as the transaction is reviewed, its status will be set to applicant reviewed . applicantKytTxnAwaitingUser Transaction status was set to awaiting user . This means that the rule requiring the applicant action, such as passing an additional check, was triggered. The scoring is stopped until the applicant completes the required flow. applicantKytTxnDataChanged Transaction data was enriched by the service. This means that the wallet ownership was confirmed, and the transaction information is unmasked. amlCaseApproved The AML case associated with the transaction was approved. No suspicious matches were found in the Sumsub databases. amlCaseRejected The AML case associated with the transaction was rejected due to the true positive matches found in the Sumsub database. amlCaseOnHold Based on the rules you applied, the AML case was put on hold and queued for a manual review by the dedicated expert.
📘 Note
We do not send any personal data via webhooks. You can fetch all the recognized data using this API method .
If you are not receiving webhooks, try to check your endpoints using SSL Labs or Docker.
JSON
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "f24f6616020245053139a6537303a251",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnApproved",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed",
"createdAtMs": "2022-10-24 12:42:07.143",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "uauu08x44xexbohyh4lkp9"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytTxnIdString A unique transaction identifier on our side (.id). kytDataTxnIdString A unique transaction identifier on your side (data.txnId).
JSON
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnRejected",
"reviewResult": {
"reviewAnswer": "RED",
"reviewRejectType": "FINAL"
},
"reviewStatus": "completed",
"createdAtMs": "2022-10-24 12:45:04.982",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytTxnIdString A unique transaction identifier on our side (.id). kytDataTxnIdString A unique transaction identifier on your side (data.txnId).
JSON
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnReviewed",
"reviewResult": {
"reviewAnswer": "RED",
"reviewRejectType": "FINAL"
},
"reviewStatus": "completed",
"createdAt": "2024-04-24 11:15:09+0000",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytTxnIdString A unique transaction identifier on our side (.id). kytDataTxnIdString A unique transaction identifier on your side (data.txnId). kytTxnTypeString Transaction type.
JSON
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnDeleted",
"reviewStatus": "completed",
"createdAt": "2024-04-24 11:15:09+0000",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytDataTxnIdString A unique transaction identifier on your side (data.txnId). kytTxnIdString A unique transaction identifier on our side (.id).
JSON
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "98d4dac61c977c1b3f81d6ab78d29c3c",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytOnHold",
"reviewStatus": "onHold",
"createdAtMs": "2022-10-24 12:44:32.341",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytTxnIdString A unique transaction identifier on our side (.id). kytDataTxnIdString A unique transaction identifier on your side (data.txnId).
JSON
{
"applicantId": "6447b564728bf40939a7664f",
"applicantType": "individual",
"correlationId": "7310f3ffddbff223cdf10221cdf12064",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnAwaitingUser",
"reviewStatus": "awaitingUser",
"createdAt": "2023-12-11 10:41:54+0000",
"createdAtMs": "2023-12-11 10:41:54.431",
"clientId": "coolClientId",
"kytTxnId": "6576e772b2f80732714d1de0",
"kytDataTxnId": "m26m980m9jd7pozq72se4",
"kytTxnType": "finance"
}
Name Type Description applicantIdString A unique applicant identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client. kytTxnIdString A unique transaction identifier on our side (.id). kytDataTxnIdString A unique transaction identifier on your side (data.txnId). kytTxnTypeString Transaction type.
JSON
{
"applicantId":"6447b564728bf40939a7664f",
"inspectionId":"6447b564728bf40939a76650",
"applicantType":"individual",
"correlationId":"fb36d7a2f2e1ac15773ec9a56f999dde",
"levelName":"basic-kyc-level",
"sandboxMode":false,
"externalUserId":"customExternalUserId",
"type":"applicantKytTxnDataChanged",
"reviewResult":{
"reviewAnswer":"RED",
"rejectLabels":[
"BAD_PROOF_OF_ADDRESS"
],
"reviewRejectType":"RETRY",
"buttonIds":[
"proofOfAddress_listOfDocs",
"proofOfAddress"
]
},
"reviewStatus":"completed",
"createdAtMs":"2023-08-30 09:52:44.301",
"clientId":"coolClientId"
}
Name Type Description applicantIdString A unique applicant identifier. inspectionIdString A unique inspection identifier. applicantTypeString The applicant type (company) or (individual). correlationIdString A unique identifier of the event. levelNameString The verification level name. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . externalUserIdString A unique user identifier on your side. typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. clientIdString You unique identifier as our client.
JSON
{
"correlationId":"26e4b45a9a0e3e8715de1b8dba0851fa",
"sandboxMode":false,
"type":"amlCaseApproved",
"reviewResult":{
"reviewAnswer":"GREEN"
},
"reviewStatus":"completed",
"createdAtMs":"2023-08-30 10:03:20.907",
"amlCaseId":"64baa015ebc52e736d147e8c"
}
Name Type Description correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. amlCaseIdString A unique identifier of an AML case.
JSON
{
"correlationId" : "f1510d9aee2f7d30c7eb33cb59f24c3c",
"sandboxMode" : false,
"type" : "amlCaseRejected",
"reviewResult" : {
"reviewAnswer" : "RED"
},
"reviewStatus" : "completed",
"createdAtMs" : "2023-08-30 10:02:36.496",
"amlCaseId" : "63652066f11034000121a52b"
}
Name Type Description correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. amlCaseIdString A unique identifier of an AML case.
JSON
{
"correlationId":"da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode":false,
"type":"amlCaseOnHold",
"reviewResult":{
"reviewAnswer":"YELLOW"
},
"reviewStatus":"onHold",
"createdAtMs":"2023-08-30 09:59:52.864",
"amlCaseId":"63d7d1bac92045720c5e354a"
}
Name Type Description correlationIdString A unique identifier of the event. sandboxModeBoolean Set to True if the webhook was sent from Sandbox . typeString The webhook type. reviewResultObject Field that contains extra information on transaction verification results. reviewStatusString The current transaction status. createdAtMsDate Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. amlCaseIdString A unique identifier of an AML case.
