Client Management

Create a customer

Creating a new customer on Vesicash is quite straightforward. The minimal amount of information required is the customer's email address and phone number. Specifying the customers first name, last name are optional.

You are only able to create customers where their email address is not already in use. Creating an account for a user that already exists will result in an error, and an HTTP 403 will be returned. Once a customer has been created, either through the API or if they've signed up themselves, their information can no longer be provided by API integrations.

post
Create a customer

https://api.vesicash.com/users
Create a new user
Request
Response
Headers
authorization
required
string
Bearer access_token
Form Data Parameters
password
required
string
User’s password
firstname
required
string
User’s first name
lastname
required
string
User’s first name
email
required
string
User's email address
phone
required
string
User’s phone number
201: Created
{
"data": {
"id": 16,
"uuid": "f1041565-4b86-4af7-b792-ef7efe6279bf",
"firstname": "John",
"lastname": "Mark",
"phone": "07012345667",
"email": "johnmark@example.com",
"profile": {
"address": null,
"state": null,
"city": null,
"country": null
},
"created_at": "2019-04-05 11:24:42",
"updated_at": "2019-04-05 11:24:42"
}
}

Login a Customer

Once a customer has been created, that customer has to be logged-in in order to create an escrow transaction.

post
Login a Customer

https://api.vesicash.com/users/login
To allow a customer login to access vesicash escrow
Request
Response
Headers
authorization
required
string
Bearer <access_token>
Form Data Parameters
email
required
string
user's email with which the account was created.
password
required
string
user's password
200: OK

Get customer details

Retrieve your own customer's details using the resource.

get
Get customer details

https://api.vesicash.com/users/{user_email}
Fetch a user
Request
Response
Path Parameters
user_email
required
string
The email address of the user to fetch.
Headers
authorization
required
string
Bearer access_token
200: OK
{
"data": {
"id": 16,
"uuid": "f1041565-4b86-4af7-b792-ef7efe6279bf",
"firstname": "John",
"lastname": "Mark",
"phone": "07012345667",
"email": "johnmark@example.com",
"profile": {
"address": null,
"state": null,
"city": null,
"country": null
},
"created_at": "2019-04-05 11:24:42",
"updated_at": "2019-04-05 11:24:42"
}
}