Skip to main content
POST
/
utils
/
otp-request
Request OTP
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/utils/otp-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '
{
  "accountNumber": "<string>"
}
'
import requests

url = "https://devapi.withedge.co/gateway/api/v1/utils/otp-request"

payload = { "accountNumber": "<string>" }
headers = {
"requestId": "<requestid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
requestId: '<requestid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({accountNumber: '<string>'})
};

fetch('https://devapi.withedge.co/gateway/api/v1/utils/otp-request', 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://devapi.withedge.co/gateway/api/v1/utils/otp-request",
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([
'accountNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"requestId: <requestid>"
],
]);

$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://devapi.withedge.co/gateway/api/v1/utils/otp-request"

payload := strings.NewReader("{\n \"accountNumber\": \"<string>\"\n}")

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

req.Header.Add("requestId", "<requestid>")
req.Header.Add("Authorization", "Bearer <token>")
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://devapi.withedge.co/gateway/api/v1/utils/otp-request")
.header("requestId", "<requestid>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountNumber\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://devapi.withedge.co/gateway/api/v1/utils/otp-request")

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

request = Net::HTTP::Post.new(url)
request["requestId"] = '<requestid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountNumber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
	"statusCode": 00,
	"message": "OTP has been sent to the account holder's phone number"
	"data": {
    "accountNumber": "0987654321",
		"otpReferenceId": "1234567890",
    "expTime": "300"
	},
	"errors": []
}

Request OTP

Use this endpoint to generate a One-Time Password (OTP) for a specific account. The OTP will be sent to the phone number associated with the account.

Additional Information

Note
  • Use the default OTP 123456 when validating OTP requests on sandbox.
  • All OTPs generated expire after 5 minutes.
  • Any active OTP on an account will expire once a new OTP request is made for the same account number.

Request Parameters

requestId
string
required
A unique identifier for the request, used for idempotency.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9
accountNumber
string
required
The account number for which the OTP is being generated.
Example: 0987654321
{
	"statusCode": 00,
	"message": "OTP has been sent to the account holder's phone number"
	"data": {
    "accountNumber": "0987654321",
		"otpReferenceId": "1234567890",
    "expTime": "300"
	},
	"errors": []
}