API Key¶
Generate Your Own API Key¶
All users are able to generate an API key for their own accounts via My Profile screen after logging in.
Once your API Access Key has been generated, click on Update to save the changes to your profile.
Generate API Key for another account¶
A Compliance Officer can generate an API Key for any user account assigned to their organisation or suborganisation.
This can be managed through Administration > User.
Once you have selected the required user account to view the profile details, click Generate for API Access Key.
Once your API Access Key has been generated, click on Update to save the changes to your profile.
Dedicated user accounts for API access only
You may like to consider using a dedicated user account for your systems to minimise any disruptions relating to an individual user's account. For example, when a staff member leaves the company and their account is deactivated.
Important Note¶
API keys are different for the Demo and Production environments and within different regions. If you have accounts in both environments, please use the environment specific key to ensure your requests are able to be authenticated and authorised.