Returns the results of checking the applicant profile for duplicates at the time of the latest automatic check.
Overview
Use this method to get a list of similar applicant profiles.
During this check, the profile data of a given applicant is compared against the profiles of other existing applicants, and matching data items (if any) are identified.
This method returns the results of duplicate detection at the time of the latest automatic check on the Sumsub side.
Mind the following:
- If an applicant was previously approved and then manually rejected as a duplicate, this method may not work properly and return an empty list of duplicates. Automatic check must be performed to ensure that a duplicate record is logged.
- When checking for duplicates, only applicants in the
completedandinitreview statuses (in case the applicant has already been approved before theinitstatus is assigned) are considered.
Request example
curl -X GET \ 'https://api.sumsub.com/resources/checks/latest?type=SIMILAR_SEARCH&applicantId=5eea3f5204f940217bcbc03d'
Response explained
The response represents a singleton list of checks with the information on matched applicant profiles as well as the specific details that caused these profiles to be considered duplicates.
Note
All attributes below are nullable.
Root variables
The following table explains the root variables of the response. Some values may include nested attributes and element fields.
| Field | Type | Description |
|---|---|---|
answer | String | Duplicates check answer:
|
checkType | String | Indicates this is a SIMILAR_SEARCH type of check. |
createdAt | Date | Date and time of the latest duplicate check result. |
id | String | Unique identifier of the check. |
similarSearchInfo | Object | Duplicate search data. |
similarSearchInfo attributes
similarSearchInfo attributesThe following table describes the fields representing the results of the similarity search.
| Field | Type | Description |
|---|---|---|
answer | String | Duplicates check answer.
|
duplicateApplicantHits | Array of objects | Contains information about the duplicates, including applicant identifiers, matched data fields, and match criteria. |
duplicateApplicantHits element fields
duplicateApplicantHits element fieldsThe following table explains the duplicateApplicantHits element fields representing the information about the duplicates, including applicant identifiers, matched data fields, and match criteria.
| Field | Type | Description |
|---|---|---|
applicantId | String | Unique identifier of the matched applicant in the Sumsub system. |
matchedFields | Array of strings | List of matched JSON info fields from the applicant profile. Applicant’s email and phone are also checked for a match. For example, info.lastName, info.idDocs.ID_CARD, info.companyInfo.companyName, and so on. |
types | Array of strings | List of match criteria:
|
Response example
{
"checks": [
{
"answer": "RED",
"createdAt": "2023-01-17 13:17:38",
"similarSearchInfo": {
"answer": "RED",
"duplicateApplicantHits": [
{
"applicantId": "61badd2937955c000144613d",
"matchedFields": [
"info.lastName",
"info.firstName",
"info.idDocs.ID_CARD",
"info.dob"
],
"types": [
"text",
"image"
]
}
]
}
}
]
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error.
For example:
{
"description": "Invalid id '123000987'",
"code": 400,
"correlationId": "4dddd499333aaf050d2080fef7ee87d0"
}
If no duplicate check has been performed, you will get an empty list of checks:
{
"checks": []
}