v1

latestOpenAPI 3.1.02026-08-0416027.2 KB

Number Insight API

This endpoint helps for Number lookup or Number Insight for a particular phone number

post/check

Request body

phone_numberstring required

phone_number should be set to a phone number starting with a country code E.g +254, +234

typestring required

type is based on the type of data you want to see about a number. This could be basic or core or standard

Response

200

codeinteger

{"stackTrail":"paths:/check:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

messagestring

statusstring

Example response

{
  "code": 200,
  "data": {
    "number": {
      "number": "2348034210294",
      "international_format_number": "+2348034210294",
      "country_code": "NG",
      "country_prefix": "234"
    }
  },
  "message": "Success",
  "status": "success"
}