# Conduit API Documentation

## Docs

- [Welcome](https://docs.conduit.financial/index.md): The Conduit platform empowers your business to move money effortlessly across stablecoins, USD, and local currencies — optimizing for speed, cost, and compliance in the regions where you do business.
- [Quickstart Guides](https://docs.conduit.financial/guides/guide-started.md): Welcome to the Conduit API getting started guide. This guide provides a quick overview of the steps to get started with the Conduit platform.
- [Setting up your API credentials](https://docs.conduit.financial/guides/authentication.md): This guide walks you through obtaining and using your Conduit API credentials so you can authenticate your requests.
- [Supported Assets](https://docs.conduit.financial/guides/supported-assets.md): Supported fiat currencies and stablecoins available through the Conduit API.
- [Compliance Requirements](https://docs.conduit.financial/guides/compliance-requirements.md): A comprehensive list of required documents and checks for Know Your Business (KYB) &  Know Your Customer (KYC) verification processes.
- [Customer Onboarding](https://docs.conduit.financial/guides/customer/onboarding-customer.md): This guide shows how to create and onboard your first customer on Conduit using the Customer API.
- [Customer Payment Method](https://docs.conduit.financial/guides/customer/first-payment-method.md): This guide shows how to add a bank account and a crypto wallet to your customer's profile. This will allow you to use these payment methods in transaction involving your customer.
- [USD Balances in Virtual Accounts](https://docs.conduit.financial/guides/virtual-accounts/usd-balance.md): Hold, view, and manage USD balances in virtual accounts
- [Counterparty Onboarding](https://docs.conduit.financial/guides/counterparty/adding-a-counterparty.md): This guide shows how to create your first counterparty on Conduit using the Counterparty API.
- [Onramp Transaction](https://docs.conduit.financial/guides/transaction/first-onramp-transaction.md): This guide shows how to create your first onramp transaction on Conduit using the Transaction API.
- [Offramp Transaction](https://docs.conduit.financial/guides/transaction/first-offramp-transaction.md): This guide shows how to create your first offramp transaction on Conduit using the Transaction API.
- [Conversion Transaction](https://docs.conduit.financial/guides/transaction/first-conversion.md): This guide shows how to create your first conversion transaction on Conduit using the Transaction API.
- [Fiat Transfer Transaction](https://docs.conduit.financial/guides/transaction/first-fiat-transfer.md): This guide shows how to create your first fiat transfer transaction on Conduit using the Transaction API.
- [Withdrawal Transaction](https://docs.conduit.financial/guides/transaction/first-withdrawal-transaction.md): Create your first crypto withdrawal transaction on Conduit using the Transactions API.
- [Deposit Transaction](https://docs.conduit.financial/guides/transaction/first-deposit-transaction.md): This guide shows how to fund a Conduit account via on‑chain deposit using the Accounts and Transactions API.
- [Configuring Webhooks](https://docs.conduit.financial/guides/webhooks/first-webhook.md): This guide shows how to create your first webhook on Conduit using the Webhook API on Conduit.
- [Overview](https://docs.conduit.financial/developer-sections/index.md): Introduction to the developer Tool in Conduit.
- [Sandbox](https://docs.conduit.financial/developer-sections/setting-up-sandbox.md): This guide shows how to set up the Conduit Sandbox.
- [Postman Collection](https://docs.conduit.financial/developer-sections/postman-collection.md): Test Conduit APIs with our pre-configured Postman collection
- [Webhooks](https://docs.conduit.financial/developer-sections/webhooks.md): Get real-time updates when certain events occur in Conduit
- [Idempotency](https://docs.conduit.financial/developer-sections/idempotency.md): Ensure safe retries and prevent duplicate operations with idempotency keys
- [Overview](https://docs.conduit.financial/core-concepts/index.md): Welcome to Conduit Core Concepts. These guides cover the fundamentals you need before using our API,how the platform works and the key resources involved. Review the sections below to get oriented and start building.
- [Clients](https://docs.conduit.financial/core-concepts/clients.md): This guide explains what a client is and how they work in Conduit.
- [Customers](https://docs.conduit.financial/core-concepts/customers.md): This guide explains what a customer is and how to add one to your account.
- [Counterparties](https://docs.conduit.financial/core-concepts/counterparties.md): This guide explains what a counterparty is and how to add one to your account.
- [Payment Methods](https://docs.conduit.financial/core-concepts/payment-methods.md): This guide explains what a payment method is and how to add one to your account.
- [Quotes](https://docs.conduit.financial/core-concepts/quotes/index.md): This guide explains what a quote is and how to create one.
- [Pricing](https://docs.conduit.financial/core-concepts/quotes/pricing.md): This guide explains how pricing works in quotes, including exchange rates, spreads, and fee calculations.
- [Virtual Accounts](https://docs.conduit.financial/core-concepts/virtual-accounts.md): Seamless Virtual Accounts for Your Global Customers
- [Overview](https://docs.conduit.financial/core-concepts/transactions/index.md): Overview of transaction types supported by Conduit.
- [Onramp](https://docs.conduit.financial/core-concepts/transactions/onramp.md): Convert fiat to crypto and deliver to a designated wallet.
- [Offramp](https://docs.conduit.financial/core-concepts/transactions/offramp.md): Convert stablecoins from your Conduit balance to fiat and deposit to a bank account.
- [Conversions](https://docs.conduit.financial/core-concepts/transactions/conversions.md): Convert fiat-to-fiat (cross-currency) and crypto-to-crypto (asset/network) with Conduit.
- [Transfers](https://docs.conduit.financial/core-concepts/transactions/fiat-transfers.md): Send same-currency bank payments using Conduit transfers.
- [Withdrawals](https://docs.conduit.financial/core-concepts/transactions/withdrawal.md): Send stablecoins from your Conduit balance to external blockchain wallets.
- [Deposits](https://docs.conduit.financial/core-concepts/transactions/deposits.md): Receive crypto into a Conduit account from an external wallet.
- [Introduction](https://docs.conduit.financial/api-reference/introduction.md): Get started with the Conduit API
- [Customer Enums](https://docs.conduit.financial/api-reference/customer-enums.md): Reference guide for customer schema enum fields and values.
- [Get account](https://docs.conduit.financial/api-reference/accounts/get-account.md): Get an existing account
- [List accounts](https://docs.conduit.financial/api-reference/accounts/list-accounts.md): List existing accounts
- [List account deposit instructions](https://docs.conduit.financial/api-reference/accounts/list-account-deposit-instructions.md): List an existing account's deposit instructions
- [Upload document](https://docs.conduit.financial/api-reference/documents/upload-document.md): Upload a new document
- [List customers](https://docs.conduit.financial/api-reference/customers/list-customers.md): List client's existing customers
- [Create a customer](https://docs.conduit.financial/api-reference/customers/create-a-customer.md): Create a new customer with explicit onboarding flow selection. Use onboardingFlow: "kyb_link" for third-party verification or onboardingFlow: "direct" for API-managed onboarding.
- [Get customer](https://docs.conduit.financial/api-reference/customers/get-customer.md): Get an existing customer
- [Delete customer](https://docs.conduit.financial/api-reference/customers/delete-customer.md): Delete an existing customer
- [Create KYB link](https://docs.conduit.financial/api-reference/customers/create-kyb-link.md): Create a KYB (Know Your Business) verification link for a customer
- [List payment methods](https://docs.conduit.financial/api-reference/customers/list-payment-methods.md): List payment methods for a customer
- [Create payment method](https://docs.conduit.financial/api-reference/customers/create-payment-method.md): Create a payment method for a customer
- [Get payment method](https://docs.conduit.financial/api-reference/customers/get-payment-method.md): Get a payment method for a customer
- [Delete payment method](https://docs.conduit.financial/api-reference/customers/delete-payment-method.md): Delete a payment method for a customer
- [Update payment method](https://docs.conduit.financial/api-reference/customers/update-payment-method.md): Update a payment method for a customer
- [Upload transaction supporting document](https://docs.conduit.financial/api-reference/customers/upload-transaction-supporting-document.md): Upload a transaction supporting document for a customer
- [Delete transaction supporting document](https://docs.conduit.financial/api-reference/customers/delete-transaction-supporting-document.md): Delete a transaction supporting document for a customer
- [Download transaction supporting document](https://docs.conduit.financial/api-reference/customers/download-transaction-supporting-document.md): Download a transaction supporting document for a customer
- [Create control persons](https://docs.conduit.financial/api-reference/customers/create-control-persons.md): Create one or more control persons for a customer
- [Upload KYC or KYB document](https://docs.conduit.financial/api-reference/customers/upload-kyc-or-kyb-document.md): Upload a KYC or KYB document
- [Submit for onboarding](https://docs.conduit.financial/api-reference/customers/submit-for-onboarding.md): Submit a customer for onboarding verification
- [Get liveness check](https://docs.conduit.financial/api-reference/customers/get-liveness-check.md): Get a liveness check for a control person
- [Get customer account](https://docs.conduit.financial/api-reference/customers/get-customer-account.md): Get account details for a customer
- [List customer accounts](https://docs.conduit.financial/api-reference/customers/list-customer-accounts.md): List existing customer accounts and their balances
- [Get customer account deposit instructions](https://docs.conduit.financial/api-reference/customers/get-customer-account-deposit-instructions.md): Get deposit instructions for a customer account
- [List Clients](https://docs.conduit.financial/api-reference/clients/list-clients.md): List all Clients (sub-sudiaries)
- [Create subsidiary](https://docs.conduit.financial/api-reference/clients/create-subsidiary.md): Create a new client (subsidiary)
- [Get client](https://docs.conduit.financial/api-reference/clients/get-client.md): Get an existing Client (subsidiary) by ID
- [Delete client (subsidiary)](https://docs.conduit.financial/api-reference/clients/delete-client-subsidiary.md): Delete an existing client (subsidiary)
- [List client payment methods](https://docs.conduit.financial/api-reference/clients/list-client-payment-methods.md): List payment methods for a client
- [Create client payment method](https://docs.conduit.financial/api-reference/clients/create-client-payment-method.md): Create a payment method for a client
- [Get client payment method](https://docs.conduit.financial/api-reference/clients/get-client-payment-method.md): Get a payment method for a client
- [Delete client payment method](https://docs.conduit.financial/api-reference/clients/delete-client-payment-method.md): Delete a payment method for a client
- [Update client payment method](https://docs.conduit.financial/api-reference/clients/update-client-payment-method.md): Update a payment method for a client
- [Get client account](https://docs.conduit.financial/api-reference/clients/get-client-account.md): Get account details for a client
- [List client accounts](https://docs.conduit.financial/api-reference/clients/list-client-accounts.md): List existing client accounts and their balances
- [Get client account deposit instructions](https://docs.conduit.financial/api-reference/clients/get-client-account-deposit-instructions.md): Get deposit instructions for a client account
- [List counterparties](https://docs.conduit.financial/api-reference/counterparties/list-counterparties.md): List client's existing counterparties
- [Create a counterparty](https://docs.conduit.financial/api-reference/counterparties/create-a-counterparty.md): Create a new counterparty
- [Get counterparty](https://docs.conduit.financial/api-reference/counterparties/get-counterparty.md): Get an existing counterparty
- [Delete counterparty](https://docs.conduit.financial/api-reference/counterparties/delete-counterparty.md): Delete an existing counterparty
- [Patch counterparty](https://docs.conduit.financial/api-reference/counterparties/patch-counterparty.md): Patch an existing counterparty
- [Delete counterparty payment method](https://docs.conduit.financial/api-reference/counterparties/delete-counterparty-payment-method.md): Delete a specific payment method for a counterparty
- [Download counterparty document](https://docs.conduit.financial/api-reference/counterparties/download-counterparty-document.md): Download a specific document for a counterparty
- [Delete counterparty document](https://docs.conduit.financial/api-reference/counterparties/delete-counterparty-document.md): Delete a specific document for a counterparty
- [Delete counterparty payment methods](https://docs.conduit.financial/api-reference/counterparties/delete-counterparty-payment-methods.md): Delete all payment methods for a counterparty
- [Create a quote](https://docs.conduit.financial/api-reference/quotes/create-a-quote.md): Create a new quote
- [List transactions](https://docs.conduit.financial/api-reference/transactions/list-transactions.md): List transactions
- [Create a transaction](https://docs.conduit.financial/api-reference/transactions/create-a-transaction.md): Create a new transaction
- [Get transaction](https://docs.conduit.financial/api-reference/transactions/get-transaction.md): Get a transaction
- [Simulate Deposit](https://docs.conduit.financial/api-reference/simulations/simulate-deposit.md): Simulate a crypto or fiat deposit into the system for the sandbox environment. This allows testing deposit flows without real blockchain transactions or actual bank transfers. Supports stablecoins (USDT, USDC, RLUSD) on various networks, and USD fiat deposits.
- [Simulate Compliance](https://docs.conduit.financial/api-reference/simulations/simulate-compliance.md): Simulate a compliance status change on a customer or counterparty.
- [Simulate Customer KYB](https://docs.conduit.financial/api-reference/simulations/simulate-customer-kyb.md): Generate KYB data and simulate KYB verification for an existing customer.
- [List webhooks](https://docs.conduit.financial/api-reference/webhooks/list-webhooks.md): List all webhooks
- [Create webhook](https://docs.conduit.financial/api-reference/webhooks/create-webhook.md): Create a new webhook endpoint
- [Get webhook](https://docs.conduit.financial/api-reference/webhooks/get-webhook.md): Get an existing webhook
- [Update webhook](https://docs.conduit.financial/api-reference/webhooks/update-webhook.md): Update an existing webhook
- [Delete webhook](https://docs.conduit.financial/api-reference/webhooks/delete-webhook.md): Delete an existing webhook
- [Changelog](https://docs.conduit.financial/changelog.md): Product updates and announcements

## OpenAPI Specs

- [openapi-external](https://api.conduit.financial/api-docs/2024-12-01/openapi-external.yaml?mode=dynamic)
- [live-external-2024-12-01](https://docs.conduit.financial/api-reference/live-external-2024-12-01.yaml)
- [openapi](https://docs.conduit.financial/api-reference/openapi.yaml)