INinfobip
connectivity
mobile-identity
identity-national-identity-number

National Identity Number check

Check if provided mobile phone number (MSISDN) belongs to user with provided national identity number.

post/mi/national-identity-number/1/check

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

consentGrantedboolean required

Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.

phoneNumberstring required

Mobile phone number (MSISDN) to perform a query by. The number must be in international format.

nationalIdstring required

National Identification Number that will be used to check for a match against a mobile phone number.

documentType'CC' | 'CE' | 'NIT'

Document type that will be used to check for a match against a mobile phone number. Currently, used and mandatory only in Colombia.

Example request

{
  "consentGranted": true,
  "phoneNumber": "441134961234",
  "nationalId": "123.456.789-10"
}

Response

OK

tokenstring uuid

Unique request identifier.

match'MATCHED' | 'NOT_MATCHED'

Match result.

Changes

No recorded changes to this operation across all 1 revision of this API.