The API architecture of Deposits is structured into several tiers — Tenants, Entities, Individuals, and, Businesses.

When you use the Deposits infrastructure for your product, you become a tenant, and as a tenant, you manage entities. An entity is a Deposits platform object that may perform transactions. Individuals and Businesses are the two types of entities.

In the fintech industry, KYC and compliance are extremely important. As a Deposits tenant, we recommend using KySync – the Deposits identity verification platform — a comprehensive solution for onboarding, verifying your users, and managing continuous compliance.

How to create a user on Deposits

To get started, log in to the console and obtain your API key.

Create a new client and wait for it to be approved. In the sandbox environment, client verification takes a few minutes as it is automatically approved. However, in the production environment, client approval is handled by our compliance team.

After creating a client, navigate to the “keys” section to obtain your API key. It is important to keep your API key private because it provides direct access to your account. Your API key should not be disclosed on public platforms and should be kept safe at all times.

key log.jpg

We can use the reference to create a user (Individual entity) using POSTMAN now that we have the API key.

The parameters required to create a user on Deposits can be found in the documentation.

You can use Postman to make a request to the create user endpoint in order to create the test user. Select "form-data" from the menu in the request body.

Screenshot 2022-06-09 at 13.00.20.png

Enter the required parameters as a key-value pair, as provided in the documentation, then submit the request using the send button.

Screenshot 2022-06-09 at 13.19.44.png

This request will return a JSON-formatted response. The status of the request, a message, and data are all included in our API responses. So, if you sent the request successfully, you should get a response like this:

carbon (24).png

You can return to the console and navigate to users to see the user we just created after receiving a success message on POSTMAN.

After you've created a user, you can use their user id to perform and record test operations and transactions.