​
Create a programmatic user

Each request to Algoreg APIs are done on the behalf of a programmatic user you first need to create.

  1. Login as an administrator to your instance of Algoreg, your instance of algoreg should be on this url format: https://backoffice.algoreg.com/
  2. Go to https://backoffice.algoreg.com/settings/developers and click “New API Key”
  3. Choose an email to identify your new user and a name. For instance, ”api-algoreg@my-company.com” and “api-algoreg”. And click on Submit. You can note the autogenerated password or ignore it (you will be able to generate a new one later).
  4. In the list of users, click on the Edit icon (pencil icon).
  5. Affect the roles prefixed by “API_”, for instance if you want to integrate Go!Vid APIs, add “API_Agent_Vid_ARO”.
  6. Click on Submit.
At any time, you can reset the key or remove the programmatic user.

​
Authentication method 1: Basic Auth

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

Authorization: Basic {base64(email:password)}

For instance if you created a programmatic user with the email api@acme.com and the password my_password, the header will be:

Authorization: Basic YXBpQGFjbWUuY29tOm15X3Bhc3N3b3Jk

You can include this header in your requests to Algoreg APIs and you will be authenticated.

​
Authentication method 2: Oauth2

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.

​
Obtain a Oauth token

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).

const api_key = "some_key";
const api_user = "some_user@domain.com";
const api_url = "https://api.algoreg.com";

async function getAccessToken() {
  const response = await fetch(api_url + "/api/v1/token", {
    method: "POST",
    body: JSON.stringify({
      grant_type: "password",
      username: api_user,
      password: api_key,
    }),
  });
  return (await response.json()).access_token;
}

console.log(await getAccessToken());

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.

​
Use the token in your requests

Now that you have a token, you can use it in your requests. You can use it in the Authorization header of your requests:

Authorization: Bearer {access_token}

​
Congratulations 🎉

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 a customer

Create your first customer using the API

Generate a session

Generate a KYC onboarding session for a customer

Transactional namesearch

Perform a single transactional namesearch


Have a great journey with Algoreg 👋

Webhooks