Skip to main content
GET
/
users
/
me
/
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>'
{
  "sent": true,
  "authSessionId": "<string>"
}
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