Warning
This API method is experimental and may change or be deprecated in the future. It is not guaranteed to remain stable, and its use may require adjustments over time.
Overview
Use this method to compare names, ensuring that manually entered applicant information matches the data in their documents.
The method takes a pair of data from the objects of idDocs array within the request body and checks if the names in these objects match.
The accuracy of the comparison depends on the comparisonMode parameter value. See the table below for details.
Attention
The
.idDocsarray can only contain two objects for comparison.
Possible comparisonMode values
comparisonMode values| Value | Description |
|---|---|
strict | Allows only an exact match:
|
weakContainment | Flexible name matching that converts names to lowercase and removes spaces for broader matches. For example, John Manuel Smith will match Johnmanuel Smith. |
def | Allows a wide range of spelling variations. For example, John M Smith and Dr. J Manuel Smith are acceptable. |
Request example
curl -X POST \
'https://api.sumsub.com/resources/checks/crossCheck?comparisonMode=strict' \
-H 'content-type: application/json' \
-d '{
"idDocs": [
{
"firstName": "John",
"lastName": "Doe"
},
{
"firstName": "Jon",
"lastName": "Dow"
}
]
}'
Response explained
The response is a JSON file representing the result of comparison.
| Name | Type | Description |
|---|---|---|
fullNameMatch | Boolean | Indicates the full name comparison result.
|
Response examples
If the request is successfully sent and processed, you will get a response like one of those below.
{
"fullNameMatch": true
}
{
"fullNameMatch": false
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"description": "idDocs size must be between 2 and 2",
"code": 400,
"correlationId": "e19584f7f457e7da5e9378fcd040f1db"
}