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 or false is returned
  • score: A score out of 100 is returned

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

PropertyTypeRequiredDescription
phoneNumberstringYesThe phone number to match the person to. This must be a valid phone number in E.164 format.
serviceTypestringYesThe type of identity match response to be retrieved. Available options are match and score.
firstNamestringNoThe first name of the person to match to.
lastNamestringNoThe last name of the person to match to.
addressstringNoHouse number and first line of the address of the person to match to.
address2stringNoOptional additional address line.
address3stringNoOptional additional address line.
postalCodestringNoPostal code of the address of the person to match to.
dateOfBirthdateNoThe 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.

{
    "firstNameMatch": true,
    "lastNameMatch": true,
    "nameMatch": true,
    "addressMatch": true,
    "postalCodeMatch": true,
    "dateOfBirthMatch": true
}

Service type match parameters

If "serviceType": "match" was provided, all of the following properties will be returned

PropertyTypeExampleDescription
firstNameMatchstringtruetrue or false for if the first name matched
lastNameMatchstringtruetrue or false for if the last name matched
nameMatchstringtruetrue or false for if the full name matched
addressMatchstringtruetrue or false for if the address matched
postalCodeMatchstringtruetrue or false for if the postal code matched
dateOfBirthMatchstringtruetrue or false for if the date of birth matched

Service type score parameters

If "serviceType": "score" was provided, all of the following properties will be returned

PropertyTypeExampleDescription
firstNameScoreinteger100Score out of 100 on the match of the first name
lastNameScoreinteger100Score out of 100 on the match of the last name
nameScoreinteger100Score out of 100 on the match of the full name
addressScoreinteger100Score out of 100 on the match of the address
postalCodeScoreinteger100Score out of 100 on the match of the postal code
dateOfBirthScoreinteger100Score out of 100 on the match of the date of birth