Getting your API credentials

This document explains how to request, set up, and maintain your API credentials.

Pre-requirement

To get your API credentials, make sure you meet the following prerequisites.

  • An active product subscription to API
  • A subscription to the digital compliance rules
  • Alternatively, an active subscription to a trial with Apiax

Refer to the Apiax Technical Requirements for more information.

Requesting your API credentials

To request your API credentials, contact Apiax.

Technical user account

As the first option, Apiax provides you with technical user accounts to access the APIs. Apiax recommends that you use these accounts or group accounts to access the APIs. Don't use personal accounts for API access to avoid losing them during employee turnover.

To set up your account, contact Apiax support, and provide the following details:

  • Name and Surname of requestee
  • Email address of requestee
  • Company full legal name
  • Address of company
  • Email contact for the technical user (should be group, not personal)
  • Contract number

Company user account

As a second option, you can use your company user account.

Have an account created in-house. Ideally, this is a technical or group account not linked to a specific employee or person.

Make sure the account:

  • Can receive emails (invitation to set up/reset password and two-factor authentication)
  • It is managed through your identity access management system (if applicable)
  • Has a name that identifies the use-case/reason for the user

Once the account exists, contact Apiax support, and provide the following details:

  • Name and Surname of the requestee
  • Email address of requestee
  • Company full legal name
  • Address of company
  • Contract number

Once you completed your account, proceed to Retrieving an API Access Token to interact with the API.

Was this article helpful?

Comments

0 comments

Article is closed for comments.

Still have questions?

Please submit a request and we will get back to you shortly.

Submit a ticket