Generate OTP for 2FA actions - Onboard Developer Documentation

Provide otp for user

curl --request GET \
  --url https://external.dev.onboardpay.co/users/me/send-otp \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://external.dev.onboardpay.co/users/me/send-otp', 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://external.dev.onboardpay.co/users/me/send-otp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://external.dev.onboardpay.co/users/me/send-otp"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.dev.onboardpay.co/users/me/send-otp")

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

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "sent": true,
  "authSessionId": "<string>"
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

GET

users

send-otp

Provide otp for user

curl --request GET \
  --url https://external.dev.onboardpay.co/users/me/send-otp \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://external.dev.onboardpay.co/users/me/send-otp', 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://external.dev.onboardpay.co/users/me/send-otp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://external.dev.onboardpay.co/users/me/send-otp"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.dev.onboardpay.co/users/me/send-otp")

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

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "sent": true,
  "authSessionId": "<string>"
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

Generates a one-time password (OTP) for actions requiring two-factor authentication (2FA), such as:

Adding or updating a payment method
Updating account security settings (e.g. enabling passkeys & TOTP)

This OTP does not grant authentication access but is instead used to verify sensitive operations within an authenticated session.

For OTPs used for authentication (sign-in/sign-up), refer to the Verify auth OTP endpoint.

Authorizations

x-auth-token

string

header

required

Query Parameters

purpose

enum<string>

required

the purpose of an otp

Available options:

SIGN_IN,

DELETE_ACCOUNT,

ADD_PAYMENT_METHOD,

EDIT_PAYMENT_METHOD,

CEX_ORDER_CONFIRMATION,

PHONE_NUMBER_VERIFICATION,

AUTHENTICATE_ACTION,

WALLET_RECOVERY,

WALLET_RESET,

MFA_SETUP

verificationChannel

enum<string>

Available options:

SMS,

WHATSAPP

Response

Success

sent

boolean

authSessionId

string