Skip to main content
In this guide, you’ll learn how to:
  • Obtain your API credentials
  • Authenticate requests using your credentials
  • Use API versioning to maintain backward compatibility

Step 1: Create an account

Start by creating an account on the Conduit Dashboard.
Once registered, you’ll have access to your organization’s workspace and can configure API access.

Step 2: Generate your API credentials

In the dashboard, go to the API Keys section and generate an API key and API secret. These credentials authenticate all your API requests.
Store them securely (for instance, in a .env file, a secrets manager, or other secure storage).
If you can’t find the API Keys section, please make sure you have admin or developer permissions. Reach out to your account manager to get access.

Step 3: Authenticate your requests

Use the X-API-Key and X-API-Secret headers in every request. Here’s an example showing how to authenticate a customer creation request:
curl --request POST \
  --url https://api.conduit.financial/customers \
  --header "X-API-Key: your_api_key" \
  --header "X-API-Secret: your_api_secret" \
  --header "Content-Type: application/json" \
  --header "Api-Version: 2024-12-01" \
  --data '{
    "name": "John Doe"
  }'

Versioning

Conduit uses API versioning to ensure backward compatibility. Specify the version in the Api-Version header of your requests. Current version: 2024-12-01

What’s next?

You’re all set to work with the Conduit API, take a look at our Quickstart Guides to get started. Use the API Reference to understand all available endpoints and request/response formats.\

Support

Reach out to our support team to get help and share your feedback.
I