Before you get started...

Prior to working on integrating the Partner API into your project, there are a few requirements to address.

Here's a checklist to help you get started:

Get Your Free Access To obtain your Partner API access:

  1. Reach out to your account manager or key point of contact at They will guide you through the process of getting your access to the Partner API Manager tool.

  2. Complete an API Due Diligence.

Create Your Application You need to create a new OAuth 2.0 application in your API settings. You can do this by visiting the Developer Portal. Log in, navigate to your API settings, and create a new application. See our Quick Start for more.

Make sure to use our production environment since the sandbox is under construction.

Familiarise Yourself With Our URLs You should be aware of the following URLs to smoothly operate with the Partner API:

With these prerequisites in place, you should be ready to begin using the Partner API. If you have any questions or need any further information, feel free to reach out to your point of contact.

Last updated