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
Personal applicant information is not available in the webhook payload. To get this information, use this API method.
Tip
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": "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode": false,
"type": "applicantFraudNetworkCreated",
"networkId": "6447b124728bf40939aa664f",
"createdAtMs": "2023-08-30 09:59:52.864"
}
| Name | Type | Description |
|---|---|---|
correlationId | String | Unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox. |
type | String | Webhook type. In this context, it is applicantFraudNetworkCreated. |
networkId | String | Unique identifier of the network. |
createdAtMs | Date | Date and time when the webhook was created, considering milliseconds (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. |
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" : "6527f43421031b3dec978570",
"applicantType" : "individual",
"correlationId": "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode": false,
"externalUserId" : "level-7781849b-229a-4a62-a3f6-7880d5b627ac",
"type": "applicantFraudNetworkModified",
"networkId": "6447b124728bf40939aa664f",
"createdAtMs": "2023-08-30 09:59:52.864"
}
| Name | Type | Description |
|---|---|---|
applicantId | String | Unique identifier of the applicant in the Sumsub system. |
applicantType | String | Defines the applicant entity type.
|
correlationId | String | Unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox. |
externalUserId | String | Unique applicant identifier as registered on your side. When creating an applicant , you can generate and add the externalUserId manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
type | String | Webhook type. In this context, it is applicantFraudNetworkModified. |
networkId | String | Unique identifier of the network. |
createdAtMs | Date | Date and time when the webhook was created, considering milliseconds (format yyyy-MM-dd HH:mm:ss.fff, e.g. 2021-05-14 16:00:25.032) in UTC. |
Updated 16 days ago