Lookup Phone Number

This endpoint returns details of a phone number

πŸ“˜

NOTE

There are two payload responses for this endpoint based on the details returned

  • Basic
  • Advanced

Phone Number Basic

Request

{{baseUrl}}api/v1/kyc/phone_number/basic?phone_number=081123456976

Header

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

Query Parameters

Parameter Type Description
phone_number * string A valid phone number required

Response Sample

{
    "entity": {
        "firstName": "JOHN",
        "MiddleName": "DOE",
        "lastName": "CHHUKWU",
        "gender": "Male",
        "nationality": "NGA",
        "dateOfBirth": "1990-05-16",
        "msisdn": "23481222222222"
    }
}

Phone Number Advanced

Request

{{baseUrl}}api/v1/kyc/phone_number?phone_number=081123456976

Query Parameters

Parameter Type Description
phone_number * string A valid phone numbe required

Response Sample

{
    "entity": {
      
        "firstname": "JOHN",
        "middlename": "DOE",
        "surname": "CHHUKWU",
        "birthdate":"1960-12-12",
        "telephoneno": "08012345678",
        "photo": "BASE 64 IMAGE",
        "gender": "M",
        "customer": "9b2ac137-5360-4050-b412-4fa6728a31fb"
    }
}

Test Credentials

phone_number = 09011111111