Prerequisites

Get your tenant ID

Before setting up this integration, you need to contact your Mercury Customer Success Manager (CSM) to authorize API access. The CSM will raise an internal request, and once approved, provide you with a Tenant ID.

Even if you already know your Tenant ID, API requests will fail until Mercury has explicitly granted access.

Email Template:

Subject: Mercury Tenant ID Request - [Your Company Name]

Hi Mercury team,

We are setting up an integration with our Mercury account. As part of this process, we need the Mercury Tenant ID.

Could you please provide us with our Tenant ID and authorize this connection on your side so we can complete the setup?

Thank you!

Best regards,

Instructions

Get your Subscription Key

1. Sign up at publicapi-developer.wearemercury.com/ (if you already have an account skip to step 4)
   
2. Enter your credentials in the sign up form and click sign up.
   
3. Activate the account
   • Follow the email you provided in the sign up form and find an email from Mercury. (check your Spam folder)
   • Click on the activation link.
     
4. Log in to your account using your credentials.
   
5. Navigate to the Products section.
   
6. Click on the API product.
   
7. Enter the subscription name you prefer and click “Subscribe.”
   
8. Under subscription details, find your subscription and reveal Primary Key. This is the Subscription key you need.
   

Connecting

Before getting started, please make sure that you have your tenant ID.

1. Choose the best-fitting server for you (UK server or US server.)
   
2. Enter the Primary Key to the Subscription Key field.
   
3. Enter the Tenant ID and press “Set up integration.”