For detailed information, refer to the API Specification on Redoc.*

*Available until May 25th. After that, it will only be visible with a Redoc user login, which is free.

This is an account API, which allows users to create an alias in their registration.

In the US financial market, bank account numbers are considered sensitive information and cannot be shared publicly for security reasons. Instead, users can create an alias that represents their bank information. There are three options available for the user to choose from:

• email
• phone number
• randomly generated number

/alias - single endpoint that allows you to perform three different actions: create, retrieve and delete an alias.

• post method is used to create an account alias. Contains the following parameter:

• get method is used to retrieve an existing account alias. Contains the following parameter:

The response body will be in JSON format and will include two properties: "type" and "value".

• delete method is used to delete an existing account alias. Contains the following parameter:

Responses include a status number that shows what the outcome of that request was.

201 - alias was successfully created.

400 - the request body was invalid.

401 - the request was unauthorized.

404 - the alias was not found.

500 - there was an internal server error.

DELETE operation does not have a response body. The API will return a status code of 204 if the deletion is successful.