Overview

Use this method to get the 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.

The 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 completed and init review statuses (in case the applicant has already been approved before the init status 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.

similarSearchInfo attributes

The following table describes the fields representing the results of the similarity search.

duplicateApplicantHits element fields

The following table explains the duplicateApplicantHits element fields representing the information about the duplicates, including applicant identifiers, matched data fields, and 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": []
}