Transaction monitoring webhooks

Transaction monitoring webhooks are used during monitoring of transactions issued by your applicants.

WebhookDescription
applicantKytTxnApprovedTransaction was approved.
applicantKytTxnRejectedTransaction was rejected.
applicantKytTxnReviewedTransaction was confirmed.
applicantKytOnHoldTransaction status was set to onHold.
applicantKytTxnAwaitingUserTransaction status was set to awaitingUser.
applicantKytTxnDataChangedTransaction data was enriched by the service.
amlCaseApprovedAML case was approved.
amlCaseRejectedAML case was rejected.
amlCaseOnHoldAML case was put on hold.

Payload attributes

The following is a collection of attributes present in webhooks.

NameTypeDescription
applicantIdStringA unique applicant identifier.
applicantTypeStringThe applicant type (company) or (individual).
correlationIdStringA unique identifier of the event.
sandboxModeBooleanSet to True if the webhook was sent from Sandbox.
externalUserIdStringA unique user identifier on your side.
typeStringThe webhook type.
reviewResultObjectField that contains extra information on transaction verification results.
reviewStatusStringThe current transaction status.
createdAtMsDateDate 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.
clientIdStringYou unique identifier as our client.
kytTxnIdStringA unique transaction identifier on our side (.id).
kytDataTxnIdStringA unique transaction identifier on your side (data.txnId).

πŸ“˜

Note

We do not send any personal data via webhooks. You can fetch all recognized data using this API method.

Payload examples

This section lists a collection of webhooks that you may receive during transaction monitoring.

πŸ“˜

Note

If you are not receiving webhooks, try to check your endpoints using SSL Labs or Docker.

applicantKytTxnApproved

{
  "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"
}

applicantKytTxnRejected

{
  "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"
}

applicantKytTxnReviewed

{
  "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"
}

applicantKytOnHold

{
  "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"
}

applicantKytTxnAwaitingUser

// applicantKytTxnAwaitingUser
{
  "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"
}

applicantKytTxnDataChanged

{
   "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"
}

amlCaseApproved

{
   "correlationId":"26e4b45a9a0e3e8715de1b8dba0851fa",
   "sandboxMode":false,
   "type":"amlCaseApproved",
   "reviewResult":{
      "reviewAnswer":"GREEN"
   },
   "reviewStatus":"completed",
   "createdAtMs":"2023-08-30 10:03:20.907",
   "amlCaseId":"64baa015ebc52e736d147e8c"
}

amlCaseRejected

{
  "correlationId" : "f1510d9aee2f7d30c7eb33cb59f24c3c",
  "sandboxMode" : false,
  "type" : "amlCaseRejected",
  "reviewResult" : {
    "reviewAnswer" : "RED"
  },
  "reviewStatus" : "completed",
  "createdAtMs" : "2023-08-30 10:02:36.496",
  "amlCaseId" : "63652066f11034000121a52b"
}

amlCaseOnHold

{
   "correlationId":"da9564f4437c9fcd059f99e0b94fa04d",
   "sandboxMode":false,
   "type":"amlCaseOnHold",
   "reviewResult":{
      "reviewAnswer":"YELLOW"
   },
   "reviewStatus":"onHold",
   "createdAtMs":"2023-08-30 09:59:52.864",
   "amlCaseId":"63d7d1bac92045720c5e354a"
}