Skip to main content
Mercury Public API credentials are provisioned by Mercury during customer onboarding — they are not self-service. If you don’t have a Mercury Public API developer portal account or a tenant-id yet, contact your Mercury account manager before starting.

​
Sign in to the Mercury Public API developer portal

The subscription-key lives inside your Mercury Public API developer portal profile (Azure API Management). Sign in with the account Mercury provisioned for your organisation.

1

Open the developer portal

Navigate to https://apim-uks-thirdpartyintegration-prod.developer.azure-api.net/ — you will be redirected to the Sign in page.

2

Enter your credentials

Fill in the Email and Password fields with the credentials Mercury issued to you during onboarding, then click Sign in. If you don’t have credentials, contact your Mercury account manager to have a portal account provisioned.

Mercury Public API developer portal sign-in page with the Email and Password fields and the Sign in button

​
Retrieve your Subscription Key

Your Mercury Public API subscription key is issued by Mercury via Azure API Management. It is the value sent as the subscription-key header on every API request.

1

Open your user profile

After signing in, click Profile in the top-right navigation to open the User profile page.

Mercury developer portal home page with the Profile link highlighted in the top-right navigation
2

Locate the Subscriptions section

Scroll down past Account details to the Subscriptions table. Find the row whose Product column is Mercury Public API and whose State column is Active.

User profile page with the Subscriptions section highlighted showing the Mercury Public API row
3

Click Show on the Primary key row

On the Primary key row, click Show to reveal the subscription-key value. Copy the full value.

  • Either the Primary key or Secondary key can be used — both authenticate against the same Mercury API product.
  • Do not click Regenerate unless you want to invalidate the current key and issue a new one — any downstream integration using the old key will stop working immediately.
Subscriptions section with the Show button on the Primary key row highlighted
4

Paste into StackOne

Paste the copied value into the Subscription Key field in StackOne.

​
Obtain your Tenant ID from Mercury

The tenant-id identifies which Mercury customer tenant your API calls operate against. It is a Mercury-specific value (not an Azure API Management concept) and is not visible in the developer portal.

1

Find the Tenant ID Mercury supplied

Mercury issues your tenant-id during onboarding — typically in the same email that delivers your developer portal credentials, or via your Mercury account manager. The value is a 32-character alphanumeric string with an unq prefix (for example unq0a4562b4117eee1181726045bdc15) — it is not a standard GUID.

2

Request it from Mercury if missing

Contact your Mercury account manager or Mercury support and request the tenant-id for the customer environment you are integrating with. A single subscription key can be used across multiple tenants, so make sure you are given the tenant-id that matches the data you intend to work with.

3

Paste into StackOne

Paste the value Mercury supplied into the Tenant ID field in StackOne.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Subscription Key
  • Tenant ID
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.