Home
API Reference

Lookup Phone Number

Suggest Edits

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

Header

Parameter

Type

Description

AppId

string

you would need to create an app to get your app ID

Authorization

string

public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Query Parameters

Parameter Type Description
phone_number * string A valid phone number required

Response Sample

{
    entity: {
        "msisdn": "2348103100000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "dateOfBirth": "18/08/1997",
        "address": " 25 Okota",
        "address_city": "Shomolu",
        "address_state": "Lagos",
        "gender": "Male"
    }
}

Phone Number Advanced

Request

{{baseUrl}}api/v1/kyc/phone_number

Query Parameters

Parameter Type Description
phone_number * string A valid phone numbe required

Response Sample

{
    "entity": {
        "nin": "701******5",
        "firstname": "JOHN",
        "middlename": "DOE",
        "surname": "CHHUKWU",
        "maidenname": "",
        "telephoneno": "08012345678",
        "state": "Ekiti",
        "place": "ADO ",
        "profession": "STUDENT",
        "title": "miss",
        "height": "****",
        "email": "[email protected]",
        "birthdate": "24-07-1970",
        "birthstate": "Ekiti",
        "birthcountry": "nigeria",
        "centralID": "1234567",
        "nok_firstname": "SELKINI",
        "nok_lastname": "MEDUSA",
        "nok_middlename": "",
        "nok_address1": "FEDERAL UNIVERSITY TECHN",
        "nok_address2": "",
        "nok_lga": "Bosso",
        "nok_state": "Niger",
        "nok_town": "MINNA",
        "photo": "BASE 64 IMAGE",
        "nspokenlang": "YORUBA",
        "ospokenlang": "ENGLISH",
        "religion": "christianity",
        "residence_Town": "IKOTUN EGBE",
        "residence_lga": "Alimosho",
        "residence_state": "Lagos",
        "residencestatus": "birth",
        "residence_AddressLine1": "26 JOHNSON STREET",
        "residence_AddressLine2": "26 JOHNSON STREET",
        "self_origin_lga": "Ikeja",
        "self_origin_place": "Ekiti",
        "self_origin_state": "Lagos",
        "signature": "BASE 64 IMAGE",
        "nationality": "Nigerian",
        "gender": "m",
        "trackingId": "S720NYFD60007KG"
    }
}

Updated about 1 month ago

Did this page help you?