Fraud Network Detection webhooks
This section lists a collection of webhooks that you may receive during the fraud network detection.
Webhook | Description |
---|---|
applicantFraudNetworkCreated | New applicant fraud network has been created. |
applicantFraudNetworkModified | Existing 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"
}
Name | Type | Description |
---|---|---|
correlationId | String | A unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox. |
type | String | The webhook type. |
createdAtMs | Date | 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. |
networkId | String | A 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"
}
Name | Type | Description |
---|---|---|
applicantId | String | A unique applicant identifier. |
applicantType | String | The applicant type: company or individual . |
correlationId | String | A unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox. |
externalUserId | String | A unique user identifier on your side. |
type | String | The webhook type. |
createdAtMs | Date | 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. |
clientId | String | Your unique identifier as our client. |
networkId | String | A unique network identifier. |
Updated 2 months ago