Identity Match
Identity Match is a service that checks a person's details to a given phone number according to their operator's data.
The service has two different responses, depending on the serviceType
in the request provided through the API.
- match:
true
orfalse
is returned - score: A score out of 100 is returned
Please note that due to mobile operator limitations, please do not exceed one request per second to avoid unnecessary errors. This limit applies collectively to all Mobile Identity services for each set of credentials.
Request
URL
POST https://api.cm.com/mobile-identity/v1/identity-match
Headers
Content-Type: application/json
Authorization: Bearer GENERATED_TOKEN_HERE
Body
{
"phoneNumber": "+31613245678",
"serviceType": "match",
"firstName": "John",
"lastName": "Doe",
"address": "Konijnenberg 24",
"postalCode": "4825 BD",
"dateOfBirth": "1965-03-10"
}
Parameters
Property | Type | Required | Description |
---|---|---|---|
phoneNumber | string | Yes | The phone number to match the person to. This must be a valid phone number in E.164 format. |
serviceType | string | Yes | The type of identity match response to be retrieved. Available options are match and score . |
firstName | string | No | The first name of the person to match to. |
lastName | string | No | The last name of the person to match to. |
address | string | No | House number and first line of the address of the person to match to. |
address2 | string | No | Optional additional address line. |
address3 | string | No | Optional additional address line. |
postalCode | string | No | Postal code of the address of the person to match to. |
dateOfBirth | date | No | The date of birth of the person to match to. In 'YYYY-MM-DD' format. |
Response
Depending on the serviceType
provided in the request, the response is different.
{
"state": "success",
"firstNameMatch": true,
"lastNameMatch": true,
"nameMatch": true,
"addressMatch": true,
"postalCodeMatch": true,
"dateOfBirthMatch": true
}
Service type match
parameters
match
parametersIf "serviceType": "match"
was provided, all of the following properties will be returned
Property | Type | Example | Description |
---|---|---|---|
firstNameMatch | boolean | true | true or false for if the first name matched |
lastNameMatch | boolean | true | true or false for if the last name matched |
nameMatch | boolean | true | true or false for if the full name matched |
addressMatch | boolean | true | true or false for if the address matched |
postalCodeMatch | boolean | true | true or false for if the postal code matched |
dateOfBirthMatch | boolean | true | true or false for if the date of birth matched |
Note that the value can be
null
if the data is not available or accessible, or that an unexpected error is returned when retrieving the data from the operator.
Service type score
parameters
score
parametersIf "serviceType": "score"
was provided, all of the following properties will be returned
Property | Type | Example | Description |
---|---|---|---|
firstNameScore | integer | 100 | Score out of 100 on the match of the first name |
lastNameScore | integer | 100 | Score out of 100 on the match of the last name |
nameScore | integer | 100 | Score out of 100 on the match of the full name |
addressScore | integer | 100 | Score out of 100 on the match of the address |
postalCodeScore | integer | 100 | Score out of 100 on the match of the postal code |
dateOfBirthScore | integer | 100 | Score out of 100 on the match of the date of birth |
Note that the value can be
-1
if the data is not available or accessible, or that an unexpected error is returned when retrieving the data from the operator.
Updated about 1 month ago