Overview
Do you have customer KYC information and want to verify the information provided to you? This API allows you to supply the government ID (ID Number, International Passport Number, Drivers' License Number, etc) together with the customers mobile number and we will let you know if there's a match.FEATURED BUNDLE
Carrier KYC VerificationFEATURES
Verify ID
Prevent ID Theft
Match KYC
Specifications
Available
endpoints
200OK
statusCode integer
HTTP error code extension
statusMessage string
Corresponding message.
phoneNumber string
phoneNumber provided in the input
data
nationalIdNumber string
NationalIdNumber value that was passed to be matched with phoneNumber data.
nationalIdNumberMatch string
Y,N-NA,N-AV,N-AD
transactionId string
Transaction ID for tracing
{
"statusCode": 1,
"statusMessage": "string",
"phoneNumber": "string",
"data": {
"nationalIdNumber": "string",
"nationalIdNumberMatch": "string"
},
"transactionId": "string"
}400Bad Request
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}401Unauthorized
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}403Forbidden
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}404Not Found
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}405Method Not Allowed
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}406Not Acceptable
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}500Internal Server Error
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}