πŸ“˜ NOTE: There are two payload responses for this endpoint based on the details returned

  • Basic
  • Advanced

Phone Number Basic

[GET]
{{baseUrl}}api/v1/kyc/phone_number/basic

ParameterTypeDescription
AppIdstringyou would need to create an app to get your app ID
Authorizationstringpublic secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Query parameters

ParameterTypeDescription
phone_number *stringA valid phone numberrequired

Sample response

Response
{
    "entity": {
        "first_name": "JOHN",
        "middle_name": "DOE",
        "last_name": "CHHUKWU",
        "gender": "Male",
        "nationality": "NGA",
        "date_of_birth": "1990-05-16",
        "msisdn": "23481222222222"
    }
}

Phone Number Advance

[GET]
{{baseUrl}}api/v1/kyc/phone_number?phone_number=081123456976

Query parameters

ParameterTypeDescription
phone_number *stringA valid phone numberequired

Sample response

Response
{
    "entity": {
        "first_name": "JOHN",
        "last_name": "DOE",
        "middle_name": "CHHUKWU",
        "date_of_birth": "1960-12-12",
        "phone_number": "08012345678",
        "photo": "BASE 64 IMAGE",
        "gender": "M",
        "customer": "9b2ac137-5360-4050-b412-4fa6728a31fb"
    }
}

Test Credentials for Sandbox

phone_number = 09011111111