Ubupay Documentation
  1. Authentication
Ubupay Documentation
  • Overview
    • Introduction
    • Getting started
  • Agent API Documentation
    • Introduction
    • Authentication
      • Agent authentication
        POST
      • OTP Request
        POST
      • OTP Verification
        POST
      • Password reset
        POST
    • Profile management
      • Create agent business profile
      • Update agent business profile
      • Retrieve agent business profile
      • Agent profile
    • Transactions
      • Transfers list
      • Transactions status amount
      • Transactions status count
      • Update transaction status
  1. Authentication

OTP Request

POST
/authentication/agent/otp/request
This endpoint will send an OTP ( One Time Password ) to your provided email.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/authentication/agent/otp/request' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "tinganjeff@ubupay.ca",
    "otp_type": "PIN_RESET"
}'
Response Response Example
{
    "status": "success",
    "message": "OTP sent successfully"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
email
string 
required
otp_type
string 
required
Examples

Responses

🟢200Success
application/json
Body
status
string 
required
message
string 
required
Previous
Agent authentication
Next
OTP Verification
Built with