Authenticate to Algoreg APIs
Each request to Algoreg APIs are done on the behalf of a programmatic user you first need to create.
You can use the basic auth method to authenticate to Algoreg APIs. You will need to use the email and password of the programmatic user you created.
The Basic Auth header is described as follows
For instance if you created a programmatic user with the email api@acme.com
and the password my_password
, the header will be:
You can include this header in your requests to Algoreg APIs and you will be authenticated.
For increased security, we recommend using the Oauth2 method to authenticate to Algoreg APIs. This method is more secure because you can generate a token that will be valid for a limited time.
We are now going to generate an access token from this programmatic user. This token will be used in any other requests made to Algoreg APIs.
The token is valid for 1 hour. You will need to generate a new one after this delay. If it is more convenient for you, you can generate a new token for each request.
Api calls must be sent to https://api.algoreg.com/ (or https://api.{instance}.algoreg.com/ if your using a specific instance).
If you try to login too many times with a wrong password, your programmatic account can be locked. In this case please contact the Algoreg support.
Now that you have a token, you can use it in your requests. You can use it in the Authorization header of your requests:
Now you can do everything in Algoreg without ever accessing our backoffice. It can be usefull to integrate Algoreg to your workflows and existing software.
Letβs jump to some of the most common APIs you will want to use with Algoreg:
Create your first customer using the API
Generate a KYC onboarding session for a customer
Perform a single transactional namesearch
Have a great journey with Algoreg π