Skip to main content

​
Request

[POST]
{{baseUrl}}/api/v1/ug/kyc/telco
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query parameter

ParameterTypeDescriptionRequired
last_name *stringLast name of the subscriberrequired
first_name *stringFirst name of the subscriber.required
phone_number *stringThe phone number of the subscriber.required

​
Sample response

Response

{
  "entity": {
    "first_name": "John",
    "last_name": "Doe",
    "name_check_error": null,
    "network_name": "",
    "percentage_name_match": 100,
    "phone_is_mm_registered": false,
    "phone_number": "+25612345678",
    "verified_name": "John Doe"
  }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the verification response data
entity.first_namestringFirst name of the subscriber
entity.last_namestringLast name of the subscriber
entity.name_check_errorstring/nullError message from name check, or null if no error
entity.network_namestringName of the mobile network operator
entity.percentage_name_matchnumberPercentage match between provided and registered names (0-100)
entity.phone_is_mm_registeredbooleanWhether the phone number is registered for mobile money
entity.phone_numberstringPhone number of the subscriber
entity.verified_namestringFull verified name from the telco records