Before starting using these endpoints you need to contact our Toqio development team, because you will need to add a specific code so you can start testing the endpoints.

To set up user credentials successfully, please follow these steps:

Step 1: Generate an encryption key

To ensure security, all credential data must be sent encrypted. To accomplish this, you'll need a key to encrypt the data. You can generate a key using the Generate customer key endpoint. Please note that this key will only be displayed once, so it's important that you save it carefully.

Step 2: Setting up user credentials using a set of endpoints

Before sending the requests, encrypt all the user data using the AES256 algorithm with the key generated in step 1.

In order to set up the credentials of a specific user, all the endpoints must be called simultaneously using the same transaction ID (Version 4 UUID) for each request. These endpoints include theCreate username, Create security questions, Create security code, and Create password. Once all four endpoints have been called, a 200 response will be received for each request. Following this, a 201 response will be received to indicate that the process has been successfully completed.

Please note that the Create security questions endpoint is only required for Modulr users. Non Modulr customers only need to call theCreate username,Create security code, and Create password endpoints.

Q&A

What happens if I lose the encryption key?
You need to contact our support team to generate a new one.

What happens if I send data in plain text?
For security reasons sensitive data can't go in plain text and must be encrypted before generating the request as explained before. Sending data in plain text will return an error

What happens if I try to use the endpoints directly?
These endpoints won't work properly without contacting our technical team and receiving the proper instructions to configure the behaviour.