# Ubupay Documentation

## Docs
- Overview [Introduction](https://doc.ubupay.ca/introduction-1054105m0.md): 
- Overview [Getting started](https://doc.ubupay.ca/getting-started-1054111m0.md): 
- Agent API Documentation [Introduction](https://doc.ubupay.ca/introduction-1054113m0.md): 

## API Docs
- Agent API Documentation > Authentication [Agent authentication](https://doc.ubupay.ca/agent-authentication-17550785e0.md): This is sign in endpoint for agent. The email and password are needed.
- Agent API Documentation > Authentication [OTP Request](https://doc.ubupay.ca/otp-request-17630298e0.md): This endpoint will send an OTP ( One Time Password ) to your provided email.
- Agent API Documentation > Authentication [OTP Verification](https://doc.ubupay.ca/otp-verification-17630450e0.md): This endpoint is to verify the OTP you received after the OTP request call. 
- Agent API Documentation > Authentication [Password reset](https://doc.ubupay.ca/password-reset-17630473e0.md): 
- Agent API Documentation > Profile management [Create agent business profile](https://doc.ubupay.ca/create-agent-business-profile-17589515e0.md): An agent business profile is necessary for the Ubupay system to link all transactions to the agent information.
- Agent API Documentation > Profile management [Update agent business profile](https://doc.ubupay.ca/update-agent-business-profile-17601598e0.md): This endpoint updates the agent business profile.
- Agent API Documentation > Profile management [Retrieve agent business profile](https://doc.ubupay.ca/retrieve-agent-business-profile-17601627e0.md): This endpoint returns the agent business profile information
- Agent API Documentation > Profile management [Agent profile](https://doc.ubupay.ca/agent-profile-17550800e0.md): This endpoint retrieves the agent profile information
- Agent API Documentation > Transactions [Transfers list](https://doc.ubupay.ca/transfers-list-17588766e0.md): This endpoint retrieves the list of transfers that the agent account received in the Ubupay platform. 
- Agent API Documentation > Transactions [Transactions status amount](https://doc.ubupay.ca/transactions-status-amount-17595322e0.md): This endpoints returns total amount for every status for the transactons linked to the agent.
- Agent API Documentation > Transactions [Transactions status count](https://doc.ubupay.ca/transactions-status-count-17595343e0.md): This endpoint returns the number of transactions for each status for the connected agent. 
- Agent API Documentation > Transactions [Update transaction status](https://doc.ubupay.ca/update-transaction-status-17595486e0.md): This endpoint allows the agent to change the status of a transaction to "successfully" done after the final client has been served.