---
title: "KYC Match"
method: POST
path: "/camara/kyc-match/v0.3/match"
tags: ["connectivity", "camara", "know-your-customer"]
---

# KYC Match

`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)
- URL: `https://api.infobip.com/camara/kyc-match/v0.3/match`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

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

## Request body

- C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeCamaraKycMatchRequestDto: Camara Know Your Customer Match request object
  - `phoneNumber` string, required: Mobile phone number (MSISDN) to verify. The number must be in international format.
  - `idDocument` string: Id number associated to the official identity document in the country.
  - `name` string: Complete name of the customer, usually composed of first/given name and last/family/sur-name in a country.
  - `givenName` string: First/given name or compound first/given name of the customer.
  - `familyName` string: Last name, family name, or surname of the customer.
  - `nameKanaHankaku` string: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
  - `nameKanaZenkaku` string: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
  - `middleNames` string: Middle name/s of the customer.
  - `familyNameAtBirth` string: Last/family/sur-name at birth of the customer.
  - `address` string: Complete address of the customer.
  - `streetName` string: Name of the street of the customer's address. It should not include the type of the street.
  - `streetNumber` string: The street number of the customer's address. Number identifying a specific property on the 'streetName'.
  - `postalCode` string: Zip code or postal code.
  - `region` string: Region/prefecture of the customer's address.
  - `locality` string: Locality of the customer's address.
  - `country` string: Country of the customer's address. Format ISO 3166-1 alpha-2.
  - `houseNumberExtension` string: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
  - `birthdate` string, date: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
  - `email` string, email: Email address of the customer in the RFC specified format (local-part@domain).
  - `gender` 'MALE' | 'FEMALE' | 'OTHER': Gender of the customer.

## Response `200`

OK

- C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeCamaraKycMatchResponseDto: Camara Know Your Customer Match response object
  - `idDocumentMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `nameMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `nameMatchScore` integer
  - `givenNameMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `givenNameMatchScore` integer
  - `familyNameMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `familyNameMatchScore` integer
  - `nameKanaHankakuMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `nameKanaHankakuMatchScore` integer
  - `nameKanaZenkakuMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `nameKanaZenkakuMatchScore` integer
  - `middleNamesMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `middleNamesMatchScore` integer
  - `familyNameAtBirthMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `familyNameAtBirthMatchScore` integer
  - `addressMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `addressMatchScore` integer
  - `streetNameMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `streetNameMatchScore` integer
  - `streetNumberMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `streetNumberMatchScore` integer
  - `postalCodeMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `regionMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `regionMatchScore` integer
  - `localityMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `localityMatchScore` integer
  - `countryMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `houseNumberExtensionMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `birthdateMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `emailMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'
  - `emailMatchScore` integer
  - `genderMatch` 'TRUE' | 'FALSE' | 'NOT_AVAILABLE'

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Platform authentication error
- `403`: Permission denied
- `404`: Not found
- `422`: Unprocessable content
- `500`: Internal server error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)