connectivity

camara

know-your-customer

KYC Match

Use this method to match customer data against Mobile Operators data.

post/camara/kyc-match/v0.3/match

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

phoneNumberstring required

Mobile phone number (MSISDN) to verify. The number must be in international format.

idDocumentstring

Id number associated to the official identity document in the country.

namestring

Complete name of the customer, usually composed of first/given name and last/family/sur-name in a country.

givenNamestring

First/given name or compound first/given name of the customer.

familyNamestring

Last name, family name, or surname of the customer.

nameKanaHankakustring

Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.

nameKanaZenkakustring

Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.

middleNamesstring

Middle name/s of the customer.

familyNameAtBirthstring

Last/family/sur-name at birth of the customer.

addressstring

Complete address of the customer.

streetNamestring

Name of the street of the customer's address. It should not include the type of the street.

streetNumberstring

The street number of the customer's address. Number identifying a specific property on the 'streetName'.

postalCodestring

Zip code or postal code.

regionstring

Region/prefecture of the customer's address.

localitystring

Locality of the customer's address.

countrystring

Country of the customer's address. Format ISO 3166-1 alpha-2.

houseNumberExtensionstring

Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.

birthdatestring date

The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).

emailstring email

Email address of the customer in the RFC specified format (local-part@domain).

gender'MALE' | 'FEMALE' | 'OTHER'

Gender of the customer.

Example request

{
  "phoneNumber": "+441134961234",
  "idDocument": "987654321",
  "name": "Jane Smith",
  "givenName": "Jane",
  "familyName": "Smith",
  "nameKanaHankaku": "ｼﾞｪｰﾝ ｽﾐｽ",
  "nameKanaZenkaku": "ジェーン スミス",
  "middleNames": "Marie",
  "familyNameAtBirth": "Johnson",
  "address": "742 Evergreen Terrace, Springfield, IL 62704",
  "streetName": " Evergreen Terrace",
  "streetNumber": "742",
  "postalCode": "62704",
  "region": "Illinois",
  "locality": "Springfield",
  "country": "US",
  "houseNumberExtension": "Apt 2B",
  "birthdate": "1985-07-15",
  "email": "jane.smith@example.com",
  "gender": "FEMALE"
}

Response

idDocumentMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

nameMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

nameMatchScoreinteger

givenNameMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

givenNameMatchScoreinteger

familyNameMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

familyNameMatchScoreinteger

nameKanaHankakuMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

nameKanaHankakuMatchScoreinteger

nameKanaZenkakuMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

nameKanaZenkakuMatchScoreinteger

middleNamesMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

middleNamesMatchScoreinteger

familyNameAtBirthMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

familyNameAtBirthMatchScoreinteger

addressMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

addressMatchScoreinteger

streetNameMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

streetNameMatchScoreinteger

streetNumberMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

streetNumberMatchScoreinteger

postalCodeMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

regionMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

regionMatchScoreinteger

localityMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

localityMatchScoreinteger

countryMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

houseNumberExtensionMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

birthdateMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

emailMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

emailMatchScoreinteger

genderMatch'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

Changes

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