Managing customers in the sandbox environment

Overview

The sandbox environment allows you to simulate the complete customer lifecycle:

Create customers
Simulate KYB verification
Change compliance status

Authentication

All requests require API key and secret authentication:

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"

1. Create 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" \
  -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

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

Create Customer

POST /customers
# Save the returned customer ID

Simulate KYB Verification

POST /simulator/customer-kyb
# Use customer ID from step 1

Activate Customer

POST /simulator/compliance
# Set customer status to "active"