> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Use the Postman collection

> A Postman collection is an organised set of requests that allows you to easily test an API. The Equals collection includes all of our available 

# Use the Equals Postman collection

A Postman collection is an organised set of requests that allows you to easily test an API. The Equals collection includes all of our available endpoints and can be used in both sandbox and production environments.

<Info>
  While we do our best to ensure that the collection is up to date, our [API reference](/api-reference/) is considered the ultimate source of truth.
</Info>

## Before you start

To use our Postman collection, you'll need to:

* have an API key
* ensure your IP address is whitelisted

This can be configured by our implementation team, who will whitelist the IP address(es) you provide, generate an API key for your sandbox environment, and share it with you.

Once your integration passes our certification process, we'll provide you with an API key for your production environment, which can also be used with the collection, if needed.

## Step 1: fork the collection

To get started, you first need to create your own fork of our Postman collection and save it to your workspace.

1. Sign up for an account or log in to an existing one on <a href="https://www.postman.com/" target="_blank">postman.com</a><span className="list-fix">.</span>
2. Click the button below:

<a href="https://god.gw.postman.com/run-collection/13008421-08d402d9-466b-4c6f-aba7-3cd5fbf540d5?action=collection%2Ffork&collection-url=entityId%3D13008421-08d402d9-466b-4c6f-aba7-3cd5fbf540d5%26entityType%3Dcollection%26workspaceId%3D02cb0da5-30d7-4053-91db-9916e04df490" target="_blank">
  <img src="https://run.pstmn.io/button.svg" alt="Run in Postman" />
</a>

3. Choose **Fork Collection**<span className="list-fix">.</span>
4. Give the fork a label and choose a workspace to save it to.
5. Tick **Watch original collection**<span className="list-fix">.</span> This means you'll be notified when we update our collection.
6. Select **Fork collection**<span className="list-fix">.</span> The fork is created and added to your chosen workspace.

## Step 2: set up your environment

To make using the collection easier, we've used variables throughout. This allows you to update key information, such as your API key or account ID, in one location and automatically apply it to the entire collection.

1. In your Postman workspace, select **Environments**<span className="list-fix">.</span> You should see that there is already a set of variables called *Sandbox*<span className="list-fix">.</span>
2. Select **Sandbox**<span className="list-fix">.</span>
3. Add your sandbox `apiKey` to the **Initial value** column and click **Save** in the top right.

<img src="https://mintcdn.com/equalsmoney-0d00329a/A-xHQkHAiyE2Q5HE/images/postman-screen.png?fit=max&auto=format&n=A-xHQkHAiyE2Q5HE&q=85&s=d2166c399f1352ed2995ee2a98693ba2" alt="Screenshot of the Sandbox environment in Postman" width="3024" height="1714" data-path="images/postman-screen.png" />

## Step 3: send your first request

Now that you're all set up, you're ready to send your first request. In this example, we'll be creating a new account.

1. In your Postman workspace, select **Collections**<span className="list-fix">.</span>
2. Select the **No Environment** drop-down in the top right and choose **Sandbox**<span className="list-fix">.</span>
3. Select **Equals API** in the left menu to expand the collection.
4. Select **Accounts & onboarding > Create accounts > Create an account**<span className="list-fix">.</span>
5. Choose one of the account types and click **Try**<span className="list-fix">.</span> A successful call returns a `200 OK` response code.

<Info>
  If you receive a `403 Forbidden`, this most likely means your IP address hasn't been whitelisted. Please contact your implementation manager.
</Info>

## What's next?

Try the **List all accounts** request to view details about the account that you've just created. Make note of the `id` and save it as your `accountId` environment variable. You should try to save new variables as you work your way through the different requests.
