Fraud Network Detection webhooks

This section lists a collection of webhooks that you may receive during the fraud network detection.

WebhookDescription
applicantFraudNetworkCreatedNew applicant fraud network has been created.
applicantFraudNetworkModifiedExisting applicant fraud network has been modified.

📘

Note

  • We do not send any personal data via webhooks. You can fetch all recognized data using this API method.
  • If you are not receiving webhooks, try to check your endpoints using SSL Labs or Docker.

applicantFraudNetworkCreated

The following example indicates that a new applicant fraud network has been found and created in the Sumsub system, so you can review its data.

{
  "correlationId": "b3b36df441a7abad9a0273e1aea5da2d",
  "sandboxMode": false,
  "type": "applicantFraudNetworkCreated",
  "createdAtMs": "2024-01-18 13:52:24.273",
  "networkId": "650aadad5cdb1a75752debd8"
}
NameTypeDescription
correlationIdStringA unique identifier of the event.
sandboxModeBooleanSet to true if the webhook was sent from Sandbox.
typeStringThe webhook type.
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.
networkIdStringA unique network identifier.

applicantFraudNetworkModified

The following example indicates that an existing applicant fraud network has been modified. Triggered when a new applicant is added to the network.

{
  "applicantId": "6504778dac791c5a518a7be0",
  "applicantType": "individual",
  "correlationId": "69458feae9006998068fbae934d242f2",
  "sandboxMode": false,
  "externalUserId": "level-675510d3-0369-40ea-b15e-2d406c7678b5",
  "type": "applicantFraudNetworkModified",
  "createdAtMs": "2024-01-18 13:34:32.897",
  "clientId": "coolClientId",
  "networkId": "650aadad5cdb1a75752debd8"
}
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.
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.
clientIdStringYour unique identifier as our client.
networkIdStringA unique network identifier.