---
title: "KYC Match API"
url: "https://developer.pxg.konera.com/apis/kyc-match-apiindia-0/versions/f0e76195-a28b-47ea-8122-88632995ac4a"
---

# KYC Match API

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"KYC Match API","description":"CAMARA KYC Match API. Matches subscriber identity details provided by a service provider with operator records.","version":"0.3.0"},"servers":[{"url":"https://api.pxg.konera.com/camara","description":"Production CAMARA API Gateway"}],"tags":[{"name":"KYC Match","description":"KYC identity matching APIs"}],"security":[{"OAuth2ClientCredentials":["kyc-match.read"]}],"paths":{"/kyc-match/v0.3/match":{"post":{"tags":["KYC Match"],"summary":"Match subscriber identity against operator records","description":"Checks whether subscriber identity attributes (such as name, address, birthdate) match operator records for the given phone number.","operationId":"kycMatch","parameters":[{"name":"x-correlation-id","in":"header","required":false,"description":"Correlation ID for request tracing","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycMatchRequest"},"example":{"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"}}}},"responses":{"200":{"description":"KYC match result returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycMatchResponse"},"example":{"match":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.konera.com/oauth2/token","scopes":{"kyc-match.read":"Read KYC match signal"}}}}},"schemas":{"KycMatchRequest":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"MSISDN in E.164 format","example":"+14155550123"},"givenName":{"type":"string","description":"Subscriber given name"},"familyName":{"type":"string","description":"Subscriber family name"},"address":{"type":"string","description":"Street address"},"locality":{"type":"string","description":"City or locality"},"region":{"type":"string","description":"Region or state"},"postalCode":{"type":"string","description":"Postal or ZIP code"},"birthdate":{"type":"string","format":"date","description":"Birthdate in YYYY-MM-DD format"},"email":{"type":"string","format":"email","description":"Email address"}}},"KycMatchResponse":{"type":"object","required":["match"],"properties":{"match":{"type":"boolean","description":"Indicates whether the provided data matches operator records","example":true}}},"Error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","example":400},"code":{"type":"string","example":"INVALID_ARGUMENT"},"message":{"type":"string","example":"Invalid request"}}}}}}
```