get https://api.sumsub.com/resources/applicantFraudNetworks/
Overview
Use this method to retrieve the fraud networks. The response would contain the found networks sorted by the date and time they were modified.
Note
If you want to get:
- Fraud networks by
applicantId, use this method.- A certain fraud network by
networkId, use this method.
Request example
The following request example returns all the found fraud networks. By default, the offset parameter is 0 and limit is 10.
https://api.sumsub.com/resources/applicantFraudNetworks/?offset=0&limit=10
Response explained
| Name | Type | Description |
|---|---|---|
network | Object | Includes the attributes of the network. |
stats | Object | Includes the statistic attributes related to the network. |
notes | Array of objects | Contains the note added to the case and the notes attributes. |
network attributes
network attributes| Name | Type | Description |
|---|---|---|
id | String | Unique network identification number. |
createdAt | Date | Date and time when the network was created. |
modifiedAt | Date | Date and time when the network was last modified. |
nodes | Array of objects | Includes the data that explains how the applicant is associated with the network. |
nodes object
nodes object| Name | Type | Description |
|---|---|---|
id | String | Unique applicant identifier. |
ips | Array of strings | Array of IP addresses connected with the applicant. |
deviceFingerprints | Array of strings | Array of device fingerprints connected with the applicant. |
imageTemplates | Array of objects | Includes the data about the applicant documents, their types and identifiers. |
addedAt | Date | Date and time when the applicant was added to the network. |
imageTemplates object
imageTemplates object| Name | Type | Description |
|---|---|---|
templateType | String | Type of connection including address, fingerprint, ip, poaTemplate, documentTemplate, selfieTemplate, and so on. |
address | String | Applicant POA address (not empty for templateType=address). |
referenceImageId | String | Unique applicant image identifier that belongs to the applicant of the same node. |
idDocType | String | Applicant document type. |
idDocSubType | String | Applicant document subtype. |
imageTemplateId | String | Unique template identification number. Similar documents, selfies, or other images have the same imageTemplateId. |
stats attributes
stats attributes| Name | Type | Description |
|---|---|---|
GREEN | Integer | Amount of approved applicants. |
RED | Integer | Amount of rejected applicants |
size | Integer | Network size. |
networkReasons | String | Indicates the reasons for network creation and its similarities. Possible values:
|
topCountries | Map of String,Integer pairs | Top applicant countries with a counter. |
medianAge | Double | Median age of the applicants included in the network. |
notes object
notes object| Name | Type | Description |
|---|---|---|
id | String | Unique note identifier. |
targetId | Integer | Object (networkId) the note relates to. |
targetType | String | applicantFraudNetwork.In general case, it also could be applicant, transaction, amlCase, kytCase. |
note | String | Note added to the case. |
createdAt | Date | Date and time when the note was created. |
modifiedAt | Date | Date and time when the note was last modified. |
createdBy | String | Note creator name. |
tags | Array of strings | Added tags. |
attachments | Array of strings | Information about the note attachments. |
clientNote | Boolean | True. |
Response example
{
"list": {
"items": [
{
"network": {
"id": "6527f5885694ddb4054b658a",
"createdAt": "2023-10-12 14:38:42+0000",
"modifiedAt": "2023-10-12 14:38:42+0000",
"nodes": [
{
"id": "6527f4f021031b3dec9785e1", // applicant id
"ips": [
"111.111.11.11",
"222.222.22.222",
"333.333.33.333",
"444.444.44.44"
],
"deviceFingerprints": [
"6a901dd64f8d68aa5b93bbfad112849e"
],
"imageTemplates": [
{
"templateType": "poaTemplate",
"referenceImageId": 1121273889, // image id within the applicant
"idDocType": "UTILITY_BILL",
"idDocSubType": "FRONT_SIDE",
"imageTemplateId": "cd6070288f0645c29d76712c514e62c0" // unique id of the group of POAs
},
...
{
"templateType": "poaTemplate",
"referenceImageId": 1667162048,
"idDocType": "DRIVERS",
"idDocSubType": "BACK_SIDE",
"imageTemplateId": "139a87b4645441fdb0916be110f7e1c2"
}
],
"addedAt": "2023-10-12 14:38:42+0000"
},
{
"id": "6527f4a521031b3dec9785cd",
"ips": [
"111.111.11.11",
"222.222.22.222",
"333.333.33.333"
],
"deviceFingerprints": [
"6a901dd64f8d68aa5b93bbfad112849e"
]...}
'''
],
},
"stats": {
"GREEN": 0,
"RED": 1,
"size": 4,
"networkReasons": [
"documentTemplate",
"poaTemplate",
"fingerprint"
],
"topCountries": {
"ALB": 1,
"DZA": 1
}
},
"notes": [
{
"id": "652804f23ad8116578e0d619",
"targetId": "6527f5885694ddb4054b658a",
"targetType": "applicantFraudNetwork",
"note": "Due to suspected fraud, access must be restricted to determine further action.",
"createdAt": "2023-10-12 14:38:42+0000",
"modifiedAt": "2023-10-12 14:38:42+0000",
"createdBy": "Service",
"tags": [
"fraud" // tags as set up in the global settings section
]
},
...
]
},
{
"network": {
"id": "652807895694ddb4054b65a7",
...
}
...
"totalItems": 8
}
}