---
updatedAt: 2025-12-17T10:33:27.000Z
agentTools:
  projectIndex: https://docs.mesh.complyadvantage.com/llms.txt
---

# Postman and OpenAPI Schema

Supercharge your ComplyAdvantage Mesh API integration

ComplyAdvantage offers a Postman collection to help you on your integration journey with the ComplyAdvantage Mesh API.

Alternatively, you can download the OpenAPI ("Swagger") schema which was used to generate these pages, and use it in your API integration. This is available <Anchor label="here" target="_blank" href="https://docs.mesh.complyadvantage.com/openapi/mesh-api.json">here</Anchor>.

*Prerequisites: You have a Postman account and are logged in.*

## Forking the Postman collection

<HTMLBlock>{`
<p style="text-indent: 1em;">1. Fork the ComplyAdvantage Mesh Postman collection by <a href="https://www.postman.com/teamcomplyadvantage/workspace/complyadvantage/collection/37100431-42eb1f77-1374-485d-999c-f2bea24f2bec/fork?origin=sidebar" target="_blank"><b>clicking here</b></a>.</p>
`}</HTMLBlock>

2. Give your collection a name and choose which workspace you want it to be saved in. Keep **Watch original collection** checked to be informed of any changes to the collection.

<Image align="center" border={true} src="https://files.readme.io/69f5df1-image.png" className="border" />

3. Choose which environment(s) you would like to fork. This will set the appropriate **baseUrl** for API calls. Once done, click **Fork Collection.**

<Image align="center" border={true} src="https://files.readme.io/0597a72-image.png" className="border" />

## Using the Postman collection

1. The collection will now be created in your workspace. In the top right corner, ensure the correct environment is selected. This will set the **baseUrl** for API calls made through this collection.

<Image align="center" border={true} src="https://files.readme.io/0057574-image.png" className="border" />

2. To ensure the token is set for API calls, firstly generate a token using the **Create an access token** endpoint. Enter your credentials in the request body and click **Send**. Copy the value of **access\_token** in the response to your clipboard.

<Image align="center" border={true} src="https://files.readme.io/3ec659c-image.png" className="border" />

3. Select **Environments** in the left hand menu and click **Globals**. Create a variable named **bearerToken** and set the **Type** as **secret**. Paste the token into the **Initial value** field. Save changes.

<Image align="center" border={true} src="https://files.readme.io/8682979-image.png" className="border" />

4. Now the token will be set for the API calls and you can begin to test out the API. Navigate back to the **Collections** menu item and try out some of the APIs. Remember, tokens expire 24 hours after generation so repeat the above steps every time a new token is generated.

## Keeping the Postman collection updated

1. If you are watching the collection, you will receive notifications within Postman on when the collection has been updated.

<Image align="center" border={true} src="https://files.readme.io/3500439-image.png" className="border" />

2. In order to pull in changes to your fork of the collection, click the three dots next to the collection name and select **Pull changes**.

<Image align="center" border={true} src="https://files.readme.io/942e29d-image.png" className="border" />

3. You will see a list of changes made to the collection. Click **Pull Changes** to update your collection.

<Image align="center" border={true} src="https://files.readme.io/b9937f5-image.png" className="border" />

## Further information

For further information on how to use Postman, visit their learning centre [**here**](https://learning.postman.com/docs/introduction/overview/).