Skip to main content
The Conduit Sandbox is a safe environment to test integrations, simulate transactions, and explore the platform without using real funds. It mirrors production behavior so you can validate workflows before going live.

Sandbox API base URL

https://sandbox-api.conduit.financial/

Important notes

  • Crypto deposits – Use simulator endpoints to deposit crypto in the sandbox.
  • Compliance screening – All checks are simulated and do not reflect real verification.

Overview

Use the sandbox to simulate the complete customer lifecycle:
  1. Create customers
  2. Simulate KYB verification
  3. Change compliance status

Authentication

All requests require API key and secret authentication. Include the Api-Version header:
curl -X POST https://sandbox-api.conduit.financial/endpoint \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -H "Api-Version: 2024-12-01"

1. Create a customer

Create a new customer in the sandbox environment. Endpoint: POST /customers

Request Example

curl -X POST https://sandbox-api.conduit.financial/customers \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -H "Api-Version: 2024-12-01" \
  -d '{
  "businessLegalName": "Acme",
  "country": "USA"
}'

Response

{
  "id": "cus_30sTSsszBuLMXKPtKjNZf65ZJEI",
  "businessLegalName": "Acme",
  "kybLink": "https://verify-sandbox.aiprise.com/?business_onboarding_session_id=id_12234",
  "kybLinkExpiration": "2025-11-03T17:34:43.629Z"
}

2. Simulate customer KYB

Generate KYB data and simulate KYB verification for an existing customer. Endpoint: POST /simulator/customer-kyb
Simulator endpoints are sandbox-only and may not appear in the public API Reference.

Request Schema

{
  "id": "string (required)",
  "countryCode": "string (required, ISO 3166-1 alpha-3)"
}

Request Example

curl -X POST https://sandbox-api.conduit.financial/simulator/customer-kyb \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
    "countryCode": "USA"
  }'

Use cases

  • Simulate KYB completion after customer creation
  • Test different country-specific flows
  • Generate synthetic KYB data for testing

3. Change compliance status

Simulate compliance status changes for customers or counterparties. Endpoint: POST /simulator/compliance

Customer compliance

Request Schema

{
  "type": "customer",
  "id": "string (required)",
  "status": "enum (required)"
}

Available customer status values

  • active
  • in_compliance_review
  • compliance_rejected
  • created
  • kyb_in_progress
  • kyb_expired
  • kyb_missing_information
  • account_onboarding_pending

Request Example

curl -X POST https://sandbox-api.conduit.financial/simulator/compliance \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "customer",
    "id": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
    "status": "active"
  }'

Counterparty compliance

Request Schema

{
  "type": "counterparty",
  "id": "string (required)",
  "status": "enum (required)"
}

Available counterparty status values

  • active
  • deleted
  • in_compliance_review
  • compliance_rejected

Request Example

curl -X POST https://sandbox-api.conduit.financial/simulator/compliance \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "counterparty",
    "id": "cp_2ofTA13AD0xBtbEvBl20aEb1hEu",
    "status": "active"
  }'

Response

{
  "success": true
}

Use cases

  • Test compliance workflow transitions
  • Simulate rejected customers/counterparties
  • Enable customers/counterparties for transactions
  • Test system behavior with different compliance states

Common testing workflows

Complete customer onboarding flow

  1. Create Customer
    POST /customers
    # Save the returned customer ID
    
  2. Simulate KYB Verification
    POST /simulator/customer-kyb
    # Use customer ID from step 1
    
  3. Activate Customer
    POST /simulator/compliance
    # Set customer status to "active"
    

What’s next?

Support

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