Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
KYC Match v0.3

Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.

Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the phoneNumber is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION error will be returned.

In order to proceed with the match check, some Operators may have the requirement to perform an additional level of validation based on the idDocument property. This means that, in those cases, the idDocument is required and the provided value needs to match the one stored in the Operator system associated with the indicated phoneNumber. This validation will be done before proceeding with the match check of the rest of the properties. The following two rules apply only in the cases where the Operator have the requirement to validate the idDocument:

  • If no idDocument is provided, then a HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED error will be returned.
  • If the provided idDocument does not match the one stored in the Operator systems, then a HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH error will be returned.

The API will return the result of the matching process for each requested attribute. This means that the response will only contain the attributes for which validation has been requested. Possible values are:

  • true: the attribute provided matches with the one in the Operator systems.
  • false: the attribute provided does not match with the one in the Operator systems.
  • not_available: the attribute is not available to validate.
post/passthrough/camara/v1/kyc-match/kyc-match/v0.3/match

Headers

x-correlatorstring

Correlation id for the different services

authorizationstring

authorization header for token

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Request body

phoneNumberstring

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.

idDocumentstring

Id number associated to the official identity document in the country. It may contain alphanumeric characters.

namestring

Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.

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. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.

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 (Male/Female/Other).

Response

nameMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

givenNameMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

familyNameMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

nameKanaHankakuMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

nameKanaZenkakuMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

middleNamesMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

familyNameAtBirthMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

addressMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

streetNameMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

streetNumberMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

regionMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

localityMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.

emailMatchScoreinteger

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.