x-correlation-idstring
Correlation ID for request tracing
Match subscriber identity against operator records
Checks whether subscriber identity attributes (such as name, address, birthdate) match operator records for the given phone number.
post
https://api.pxg.konera.com/camara/kyc-match/v0.3/match
Headers
Body
application/json
Body
application/json
KycMatchRequest
phoneNumberstringrequired
MSISDN in E.164 format
Example:+14155550123
givenNamestring
Subscriber given name
familyNamestring
Subscriber family name
addressstring
Street address
localitystring
City or locality
regionstring
Region or state
postalCodestring
Postal or ZIP code
birthdatestring(date)
Birthdate in YYYY-MM-DD format
emailstring(email)
Email address
Response
application/json
Response
application/json
KYC match result returned
KycMatchResponse
matchbooleanrequired
Indicates whether the provided data matches operator records
Example:true
post/kyc-match/v0.3/match
Authentication
Headers
Body
{
"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"
}
application/json
KycMatchRequest
objectphoneNumberstringrequired
MSISDN in E.164 format
Example:+14155550123
givenNamestring
Subscriber given name
familyNamestring
Subscriber family name
addressstring
Street address
localitystring
City or locality
regionstring
Region or state
postalCodestring
Postal or ZIP code
birthdatestring(date)
Birthdate in YYYY-MM-DD format
emailstring(email)
Email address
Example
KycMatchResponse
objectmatchbooleanrequired
Indicates whether the provided data matches operator records
Example:true
Example
Error
objectstatusintegerrequired
Example:400
codestringrequired
Example:INVALID_ARGUMENT
messagestringrequired
Example:Invalid request
Example