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

# Postman Collection

> Test Conduit APIs with our pre-configured Postman collection

## Quick Start

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

<Card title="Open in Postman" icon="arrow-up-right-from-square" href="https://www.postman.com/conduit-fi/workspace/conduit-public/collection/44727866-310d5cb6-7754-4f8a-92ad-c73527707f35?action=share&creator=44727866">
  Fork the collection to your workspace and start testing immediately
</Card>

## 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

<Steps>
  <Step title="Open the Collection">
    Click the button above to open the collection in Postman
  </Step>

  <Step title="Fork the Collection">
    Click **Fork** in the top right to copy the collection to your workspace
  </Step>

  <Step title="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
  </Step>

  <Step title="Start Testing">
    All requests are ready to use! Select any endpoint and click **Send**.
  </Step>
</Steps>

## Getting API Credentials

To get your API credentials:

1. Log in to [Conduit Portal](https://portal.conduit.financial)
2. Navigate to **API Keys**
3. Generate new credentials

<Warning>
  Keep your API secret secure. Never commit it to version control.
</Warning>

## Environment Variables

The collection includes these pre-configured variables:

| Variable            | Default Value                           | Description          |
| ------------------- | --------------------------------------- | -------------------- |
| `client_base_url`   | `https://sandbox-api.conduit.financial` | Sandbox API endpoint |
| `client_api_key`    | (empty)                                 | Your API key         |
| `client_api_secret` | (empty)                                 | Your API secret      |
| `api_version`       | `2024-12-01`                            | Current API version  |

<Note>
  To switch to production, update `client_base_url` to `https://api.conduit.financial`.
</Note>

## Available Endpoints

The collection includes the following endpoint groups:

<AccordionGroup>
  <Accordion title="Accounts (9 endpoints)">
    * **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`
  </Accordion>

  <Accordion title="Documents (1 endpoint)">
    * **Upload Document** - `POST /documents`
  </Accordion>

  <Accordion title="Customers (17 endpoints)">
    * **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`
  </Accordion>

  <Accordion title="Counterparties (9 endpoints)">
    * **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}`
  </Accordion>

  <Accordion title="Quotes (2 endpoints)">
    * **Create Quote** - `POST /quotes`
    * **Get Quote Details** - `GET /quotes/{id}`
  </Accordion>

  <Accordion title="Transactions (3 endpoints)">
    * **List Transactions** - `GET /transactions`
    * **Create Transaction** - `POST /transactions`
    * **Get Transaction** - `GET /transactions/{id}`
  </Accordion>

  <Accordion title="Webhooks (5 endpoints)">
    * **Create Webhook** - `POST /webhooks`
    * **Update Webhook** - `PUT /webhooks/{id}`
    * **List Webhooks** - `GET /webhooks`
    * **Get Webhook** - `GET /webhooks/{id}`
    * **Delete Webhook** - `DELETE /webhooks/{id}`
  </Accordion>

  <Accordion title="Simulations - Sandbox Only (3 endpoints)">
    * **Simulate Deposit** - `POST /simulator/deposit`
    * **Simulate Compliance** - `POST /simulator/compliance`
    * **Simulate Customer KYB** - `POST /simulator/customer-kyb`
  </Accordion>
</AccordionGroup>

## Need Help?

<CardGroup cols={2}>
  <Card title="API Reference" icon="book" href="/api-reference/introduction">
    View detailed API documentation
  </Card>

  <Card title="Sandbox Setup" icon="flask" href="/developer-sections/setting-up-sandbox">
    Learn how to set up the sandbox
  </Card>

  <Card title="Authentication Guide" icon="key" href="/guides/authentication">
    Set up your API credentials
  </Card>

  <Card title="Contact Support" icon="envelope" href="mailto:support@conduitpay.com">
    Get help from our team
  </Card>
</CardGroup>