Logo

Getting Started

IntroductionAuthentication

OTP

POSTRequest OTPPOSTVerify OTPDELETERevoke OTPGETGet TokenGETGet OTP by Recipient

Texts

POSTSend SMSSMS Final Status CodesSMS Character Sets

Lookup

GETPhone Lookup

Mails

POSTSend Email

Airtime

POSTBuy Airtime

Lists

GETGet contact listGETGet rowPOSTCreate rowPATCHUpdate rowDELETEDelete row
Logo
DocumentationAPI ReferenceChangelog

OTP

Request OTP

Request an OTP token to be sent to a recipient

Request

curl -X POST "https://api.simpu.co/otp/request_token" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "2348023456789",
    "length": 6,
    "expires_in": 30,
    "token": "123456",
    "channel": "sms"
  }'

Response

{
  "id": "674535b2b39158b9aae90188fcec23eb",
  "recipient": "2348023456789",
  "status": 1,
  "status_desc": "SENT",
  "created_datetime": "2024-06-28T23:56:38.128604+00:00",
  "updated_datetime": "2024-06-28T23:56:38.128604+00:00"
}
POST

/otp/request_token

Request Body

application/json

OTP request object

recipient
stringrequired
Recipient of the OTP token
Example: "2348023456789"
length
numberdefault: 4
Length of the OTP token
Required range: 4 <= x <= 8
Example: 6
expires_in
numberdefault: 15
Time in minutes before the OTP token expires
Required range: 1 <= x <= 60
Example: 30
token
string
The OTP token to send to the recipient, if not specified, a new token will be generated
Example: "123456"
channel
string
Channel to send the OTP token
Allowed values: "sms" | "whatsapp"
Example: "sms"

Response

application/json

OTP response

id
stringrequired
ID of the OTP token
Example: "674535b2b39158b9aae90188fcec23eb"
recipient
stringrequired
Recipient of the OTP token
Example: "2348023456789"
status
numberrequired
Status of the OTP token
Example: 1
status_desc
stringrequired
Description of the status of the OTP token
Example: "SENT"
created_datetime
stringrequired
Date and time the OTP token was created
Example: "2024-06-28T23:56:38.128604+00:00"
updated_datetime
string
Date and time the OTP token was last updated, if any
Example: "2024-06-28T23:56:38.128604+00:00"

Built with Chakra UI

Request

curl -X POST "https://api.simpu.co/otp/request_token" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "2348023456789",
    "length": 6,
    "expires_in": 30,
    "token": "123456",
    "channel": "sms"
  }'

Response

{
  "id": "674535b2b39158b9aae90188fcec23eb",
  "recipient": "2348023456789",
  "status": 1,
  "status_desc": "SENT",
  "created_datetime": "2024-06-28T23:56:38.128604+00:00",
  "updated_datetime": "2024-06-28T23:56:38.128604+00:00"
}