KYC Match API

Overview

The KYC Match API compares subscriber identity attributes provided by a service provider against operator records for a given phone number.

• Version: 0.3.0
• Base URL: https://api.pxg.konera.com/camara
• Path: /kyc-match/v0.3/match
• OpenAPI: kyc-match.json

Typical use cases

• Digital onboarding – Cross‑check user‑supplied identity data with operator records during signup.
• KYC refresh – Periodically re‑validate identity information against operator data.
• Fraud and AML controls – Detect mismatches between declared identity and network subscriber data.

Security

• OAuth2 Client Credentials
  • Token URL: https://auth.konera.com/oauth2/token
  • Scope: kyc-match.read – Read KYC match signal

Headers

• x-correlation-id (optional, string) – Correlation ID for request tracing.

Request

POST https://api.pxg.konera.com/camara/kyc-match/v0.3/match

Body schema: KycMatchRequest

{
  "phoneNumber": "+14155550123",
  "givenName": "John",
  "familyName": "Doe",
  "address": "123 Main Street",
  "locality": "San Jose",
  "region": "CA",
  "postalCode": "95131",
  "birthdate": "1988-04-12",
  "email": "john.doe@example.com"
}

• phoneNumber (string, required) – MSISDN in E.164 format.
• Other fields (optional) – Identity attributes (name, address, birthdate, email, etc.) used for matching.

Responses

200 – KYC match result returned

Body schema: KycMatchResponse

{
  "match": true
}

• match (boolean) – Indicates whether the provided data matches operator records.

HTTP status codes

Standard Error schema with:

• 200 OK – Match computation successful.
• 400 Bad Request – Invalid or incomplete input attributes.
• 401 Unauthorized – Invalid/missing token.
• 403 Forbidden – Caller not permitted to use KYC data.
• 429 Too Many Requests – Rate limit exceeded.
• 500 Internal Server Error – Unexpected server error.