Skip to main content

​
Quick Start

Our Postman collection includes all Conduit API endpoints pre-configured for sandbox testing.

Open in Postman

Fork the collection to your workspace and start testing immediately

​
What’s Included

  • ✅ All public API endpoints
  • ✅ Pre-configured sandbox environment
  • ✅ Environment variables for easy switching
  • ✅ Example requests with documentation
  • ✅ Automatic header management

​
Setup Instructions

1

Open the Collection

Click the button above to open the collection in Postman
2

Fork the Collection

Click Fork in the top right to copy the collection to your workspace
3

Set Your Credentials

  1. Click the collection name
  2. Go to the Variables tab
  3. Set client_api_key to your API key
  4. Set client_api_secret to your API secret
4

Start Testing

All requests are ready to use! Select any endpoint and click Send.

​
Getting API Credentials

To get your API credentials:
  1. Log in to Conduit Portal
  2. Navigate to API Keys
  3. Generate new credentials
Keep your API secret secure. Never commit it to version control.

​
Environment Variables

The collection includes these pre-configured variables:
VariableDefault ValueDescription
client_base_urlhttps://sandbox-api.conduit.financialSandbox API endpoint
client_api_key(empty)Your API key
client_api_secret(empty)Your API secret
api_version2024-12-01Current API version
To switch to production, update client_base_url to https://api.conduit.financial.

​
Available Endpoints

The collection includes the following endpoint groups:
  • List Accounts - GET /accounts
  • Get Account - GET /accounts/{id}
  • Get Deposit Instructions - GET /accounts/{id}/deposit-instructions
  • All Client Accounts - GET /clients/accounts
  • Client Account - GET /clients/{client_id}/account
  • Client Deposit Instructions - GET /clients/{client_id}/account/deposit-instructions
  • All Customer Accounts - GET /customers/accounts
  • Customer Account - GET /customers/{customer_id}/account
  • Customer Deposit Instructions - GET /customers/{customer_id}/account/deposit-instructions
  • Upload Document - POST /documents
  • List Customers - GET /customers
  • Create Customer - POST /customers
  • Get Customer - GET /customers/{id}
  • Delete Customer - DELETE /customers/{id}
  • Create KYB Link - POST /customers/{id}/kyb-link
  • List Payment Methods - GET /customers/{id}/payment-methods
  • Create Payment Method - POST /customers/{id}/payment-methods
  • Update Payment Method - PATCH /customers/{id}/payment-methods/{paymentMethodId}
  • Get Payment Method - GET /customers/{id}/payment-methods/{paymentMethodId}
  • Delete Payment Method - DELETE /customers/{id}/payment-methods/{paymentMethodId}
  • Upload Transaction Supporting Document - POST /customers/{id}/documents
  • Delete Transaction Supporting Document - DELETE /customers/{id}/documents/{documentId}
  • Download Transaction Supporting Document - GET /customers/{id}/documents/{documentId}/download
  • Create Control Persons - POST /customers/{id}/control-persons
  • Upload KYC or KYB Document - POST /customers/onboarding/{id}/documents
  • Submit for Onboarding - POST /customers/{id}/submit
  • Get Liveness Check - GET /customers/{id}/control-persons/{controlPersonId}/liveness
  • List Counterparties - GET /counterparties
  • Create Counterparty - POST /counterparties
  • Get Counterparty - GET /counterparties/{id}
  • Update Counterparty - PATCH /counterparties/{id}
  • Delete Counterparty - DELETE /counterparties/{id}
  • Delete Counterparty Payment Method - DELETE /counterparties/{id}/payment-methods/{paymentMethodId}
  • Delete Counterparty Payment Methods - DELETE /counterparties/{id}/payment-methods
  • Download Counterparty Document - GET /counterparties/{id}/documents/{documentId}
  • Delete Counterparty Document - DELETE /counterparties/{id}/documents/{documentId}
  • Create Quote - POST /quotes
  • Get Quote Details - GET /quotes/{id}
  • List Transactions - GET /transactions
  • Create Transaction - POST /transactions
  • Get Transaction - GET /transactions/{id}
  • Create Webhook - POST /webhooks
  • Update Webhook - PUT /webhooks/{id}
  • List Webhooks - GET /webhooks
  • Get Webhook - GET /webhooks/{id}
  • Delete Webhook - DELETE /webhooks/{id}
  • Simulate Deposit - POST /simulator/deposit
  • Simulate Compliance - POST /simulator/compliance
  • Simulate Customer KYB - POST /simulator/customer-kyb

​
Need Help?

API Reference

View detailed API documentation

Sandbox Setup

Learn how to set up the sandbox

Authentication Guide

Set up your API credentials

Contact Support

Get help from our team