Logo

Getting Started

IntroductionAuthentication

OTP

POSTRequest OTPPOSTVerify OTPDELETERevoke OTPGETGet TokenGETGet OTP by Recipient

Lookup

GETPhone Lookup

Lists

GETGet contact listGETGet rowPOSTCreate rowPATCHUpdate rowDELETEDelete row
Logo
DocumentationAPI ReferenceChangelog

Lookup

Phone Lookup

Look up information about a phone number

Request

curl -X GET "https://api.simpu.co/lookup/phone" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "2348089672786"
  }'

Response

{
  "msisdn": "2348089672786",
  "operator": "MTN",
  "country": "Nigeria",
  "ported": false,
  "dnd": false
}
GET

/lookup/phone

Request Body

application/json

Lookup phone object

phone
stringrequired
The phone number to be looked up
Example: "2348089672786"

Response

application/json

Lookup phone response

msisdn
stringrequired
The phone number looked up
Example: "2348089672786"
operator
string
The carrier of the phone number
Example: "MTN"
country
string
The country of the phone number
Example: "Nigeria"
ported
boolean
The ported status of the phone number
Example: false
dnd
boolean
The DND status of the phone number
Example: false

Built with Chakra UI

Request

curl -X GET "https://api.simpu.co/lookup/phone" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "2348089672786"
  }'

Response

{
  "msisdn": "2348089672786",
  "operator": "MTN",
  "country": "Nigeria",
  "ported": false,
  "dnd": false
}