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

Agent authentication

POST
/authentication/agent/signin
This is sign in endpoint for agent. The email and password are needed.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/authentication/agent/signin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "tinganjeff90@gmail.com",
    "password": "password"
}'
Response Response Example
{
    "status": "success",
    "message": "Sign in successful",
    "tokens": {
        "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.H...",
        "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.K...."
    }
}

Request

Body Params application/json
email
string 
required
password
string 
required
Examples

Responses

🟢200OK
application/json
Body
status
string 
required
"success" or "error"
message
string 
required
tokens
object 
required
refresh
string 
required
access
string 
required
The access token that will be used in every authenticated requests.
Previous
Introduction
Next
OTP Request
Built with