On-boarding

The on-boarding process begins from the point where a user is created and ends when the user has completely supplied all identity details that we require to ensure that such user is a valid person.
Signup a new user
To gain access to secure your payments in the Vesicash escrow, users go through the signup phase of the on-boarding process. The minimal  information required to create a new user are email address, phone number and country. 
However, the user will be required to complete other missing information (like username, first name, last name and password) as well their bank details (for refund and disbursement) for their transaction requests to be considered valid.
You are only able to create users where their email address and phone number is not already in use. Creating an account for a user that already exists will result in an error, and an HTTP 400 will be returned. This means that once a user has been created, either through the API or if they've signed up themselves, their information can no longer be provided to recreate such user.
Once a user has been created, such user has to be authenticated every time they needs to perform actions on the escrow system. We have made provision for two possible login combination. Both are dependent on the user interface you are presenting your customers with. 
Once a user has been created, they will then receive an email introducing them to Vesicash and to log in and reset their password.
Note:
While you are welcome to create users independent of transactions, this step is not strictly necessary. A user's account will be created for any person involved in a transaction who does not already have an account at the time of transaction creation. The customer creation feature exists to allow you to set your customers up in the vesicash database, which in turn allows them to configure their account and go through the identity verification process before a transaction is started (this helps avoid transaction delays related to customer account configuration by getting that work done ahead of time).
post
https://api.vesicash.com/v1
/auth/signup
Signup a new user
As an example, you can a make a post request to the endpoint above by passing the raw json data below to signup a new user:
1
{
2
    "email_address": "[email protected]",
3
    "phone_number": "0201410000",
4
    "country": "GH" //Or "Ghana"
5
}
Copied!
This will return the created user details along with their account_id which you can then pass in as the parties field when creating a new transaction. Check the sample response above for more details.
Login a user
Once a user has been created, such user has to be authenticated every time they needs to perform actions on our escrow system. We have made provision for two possible login combination which are dependent on the user interface you are presenting your customers with. The possible login options are:
post
https://api.vesicash.com/v1
/auth/login
Login (using username and password)
post
https://api.vesicash.com/v1
/auth/login
Login (using email address and phone number)

API DOCUMENTATION - Previous

User Management

Account management

Last modified 1mo ago

Copy link

Contents