KYC Verification
KYC Verification API
The KYC Verification endpoint checks the details a customer gives you against the identity information MTN has on record for their phone number.
It does not return the customer's KYC data. Instead, it gives each field a match score, so you can see how closely the details you submitted match MTN's records.
Unlike KYC Details, this endpoint is synchronous. The customer doesn't need to give consent on their device, and you get the result straight away in the response.
Verify Customer KYC​
Sends the customer's details to be matched against MTN's records and returns a score for each field.
POST: https://api.creditchek.africa/v1/telco/v1/ng/mtn/kyc-verify
Request Parameters​
| Name | Position | Required | Description |
|---|---|---|---|
| token | Headers | True | app secret key |
curl --location 'https://api.creditchek.africa/v1/telco/v1/ng/mtn/kyc-verify' \
--header 'token: {{token}}'
--data-raw '{
"customerId": "2347062021000",
"firstName": "test",
...
}'\
{
"customerId": "2347062021000",
"firstName": "test",
"middleName": "test",
"lastName": "Kumar",
"alternativeNumber": "09057458888",
"phoneNumber": "2347062021000",
"email": "[email protected]",
"city": "city",
"streetAddress": "street",
"nationality": "NIGERIA"
}
Sample Response​
Success response of Customer KYC Verification Scores
Each field in verificationScores shows how closely the value you sent matches MTN's record for that phone number.
{
"status": true,
"data": {
"customerId": "2347062021000",
"statusCode": "0000",
"statusMessage": "Success.",
"transactionId": "rrt-3097635738146951410-d-geu1-2904922-38764942-2",
"verificationScores": {
"firstName": 18,
"middleName": -1,
"lastName": 29,
"alternativeNumber": -1,
"phoneNumber": 100,
"email": -1,
"streetAddress": 9,
"city": 44,
"nationality": 93,
"dateOfBirth": -1,
"idExpiryDate": -1
}
},
"message": "KYC verification completed",
"error": false
}