API Key Authentication | Parallel Developer Documentation

Creating an API Key

You can create an API Key that will allow you to access the API.

Configuration Access

If you're creating an API Key in production and need access to your company's account on app.parallelmarkets.com, any of your company's admins can create an account for you.

If you're creating an API Key in our demo environment for testing and need access to your company's account on demo.parallelmarkets.com, you'll need to reach out to the Partner Integrations Team and request access.

You can create a new API Key by logging into app.parallelmarkets.com (or, if you're setting up a client in our demo environment for testing, at demo.parallelmarkets.com) and then:

  1. Select your company from the dropdown on the top right of the screen. You should now see your company's dashboard.
  2. Click the "Settings" menu dropdown.
  3. Select "Integrations & Exports".

You should now see a screen where you can create a new API Key.

info
Only company users with the "admin" or "controller" role can create new API Keys. If you don't see a form to create a new API Key on your company's "Integrations & Exports" it's likely you don't have correct permissions. Please reach out to one of your company's admins or the Partner Integrations Team if you need help.

When creating a new API Key, the only field you need to provide is a name for your key (this can always be changed later).

Once your key is created, you will be able to see the full key only once. Going forward, you will only be able to see the initial prefix (what we call the "Key ID") of the full key so that you can easily identify it within your systems.

Using an API Key to Access the API

Once your key is created, you can use it to access the API.

You must send an Authorization header with a value of Bearer {apiKey}, where {apiKey} is the full key shown at creation time.

For example, to List Individuals via the Case Management API:

curl https://api.parallelmarkets.com/v2/partner-records/individuals \
  -H "Authorization: Bearer ${APIKEY}"