Getting Started

Learn how to set up your account, API credentials, and make your first call.

Sandbox Account & API Keys

Go here to start gaining access to Sandbox API Keys and to make authenticated calls.

API Authentication

Conduit uses custom HTTP headers to authenticate requests. Each header contains one part of your API credentials.

X-API-Key: The Key Identifier you received during onboarding

X-API-Secret: The Key Secret you received during onboarding

Make Your First API Call

Let's use your API credentials to make your first call. You can use Postman or cURL to get a feel for our APIs before writing any code.

When your API credentials are issued, we automatically register a single account holder (user) and create a corresponding account. So for our first call, let's query for a list of account holders.

Postman

1. Download this Postman Collection to help get you started and import it into Postman.

2. Create a new environment called Conduit Sandbox with your API Key and API Key Secret as shown below and make sure to switch to that environment on the top right.

3. In the "Collection" tab, find the GET request List Account Holders and click "Send".

4. If successful, you will see a similar response from the API.

cURL

1. Run the following query:

curl \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  https://sandbox.conduit.financial/account-holders

2. If successful, you will see a similar response from the API with your entity's name as firstName:

{
  "data": [
    {
      "id": "id:ahl:2IEoxG0HmxpbpfsYs9WXjAbI3Gh",
      "type": "account-holder",
      "attributes": {
        "externalId": null,
        "firstName": "Conduit",
        "lastName": "Financial",
        "verificationStatus": "pending"
      },
      "relationships": {
        "accounts": {
          "links": {
            "next": null,
            "self": "/account-holders/id:ahl:2IEoxG0HmxpbpfsYs9WXjAbI3Gh/relationships/accounts",
            "related": "/account-holders/id:ahl:2IEoxG0HmxpbpfsYs9WXjAbI3Gh/accounts"
          },
          "data": [
            {
              "id": "id:acct:2IEp9oFQwLpSBH5UsNA9Vh1EezH",
              "type": "account"
            }
          ]
        }
      }
    }

Next Steps

Now that you’re successfully making authenticated requests to the API with your API key, you’re ready to dive into the Conduit API.

The first thing you may want to do is learn how to register your first user using the API or browse our other guides.