Skip to main content
POST
/
otp
/
request_token
cURL
curl --request POST \
  --url https://api.simpu.co/otp/request_token \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": "2348023456789",
  "length": 6,
  "expires_in": 30,
  "token": "123456",
  "channel": "sms"
}
'
import requests

url = "https://api.simpu.co/otp/request_token"

payload = {
"recipient": "2348023456789",
"length": 6,
"expires_in": 30,
"token": "123456",
"channel": "sms"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipient: '2348023456789',
length: 6,
expires_in: 30,
token: '123456',
channel: 'sms'
})
};

fetch('https://api.simpu.co/otp/request_token', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simpu.co/otp/request_token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipient' => '2348023456789',
'length' => 6,
'expires_in' => 30,
'token' => '123456',
'channel' => 'sms'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.simpu.co/otp/request_token"

payload := strings.NewReader("{\n \"recipient\": \"2348023456789\",\n \"length\": 6,\n \"expires_in\": 30,\n \"token\": \"123456\",\n \"channel\": \"sms\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.simpu.co/otp/request_token")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipient\": \"2348023456789\",\n \"length\": 6,\n \"expires_in\": 30,\n \"token\": \"123456\",\n \"channel\": \"sms\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.simpu.co/otp/request_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipient\": \"2348023456789\",\n \"length\": 6,\n \"expires_in\": 30,\n \"token\": \"123456\",\n \"channel\": \"sms\"\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"status": 200,
"message": "Invalid request",
"errors": [
{
"field": "name",
"message": "Error in field: 'name' Field required.",
"type": "missing"
}
]
}

Authorizations

Authorization
string
header
required

An API key to authenticate requests

Body

application/json

OTP request object

recipient
string
required

Recipient of the OTP token

Example:

"2348023456789"

length
number
default:4

Length of the OTP token

Required range: 4 <= x <= 8
Example:

6

expires_in
number
default: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
enum<string>

Channel to send the OTP token

Available options:
sms,
whatsapp
Example:

"sms"

Response

OTP response

id
string
required

ID of the OTP token

Example:

"674535b2b39158b9aae90188fcec23eb"

recipient
string
required

Recipient of the OTP token

Example:

"2348023456789"

status
number
required

Status of the OTP token

Example:

1

status_desc
string
required

Description of the status of the OTP token

Example:

"SENT"

created_datetime
string
required

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"