Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

A merchant onboarding moves through five steps. Each is documented in its own page; this overview ties them together.

The sequence

1

Create the merchant

Create the legal entity (the venue operator) as a merchant in ClearBox. See Create a merchant.
2

KYB verification

Run the business through ClearCheck KYB — beneficial owners, registration documents, sanctions screening. See KYB verification.
3

Add locations

Add the physical sites where transactions will happen — a stage, a food hall, a campus building.
4

Register terminals

Register each terminal at each location and link it to the existing POS or wristband system. See Locations & terminals.
5

Configure settlement

Add the bank or stablecoin destination where payouts should arrive. See Settlement & payouts.

1. Create the merchant

Create the merchant record with the operator’s legal information and preferred settlement currency.
POST /v1/merchants
Authorization: Bearer $CLEARBOX_API_KEY
Content-Type: application/json
{
  "legal_name": "Pacific Music Festival LLC",
  "display_name": "Pacific Music Festival",
  "country": "US",
  "category": "festival",
  "settlement_currency": "USD",
  "contact_email": "ops@pacificfest.example.com"
}
The response includes a merchant_id and kyb_status: "pending_kyb". The merchant cannot accept settled transactions until KYB completes and kyb_status is active.
{
  "merchant_id": "mer_7d3a",
  "legal_name": "Pacific Music Festival LLC",
  "display_name": "Pacific Music Festival",
  "country": "US",
  "category": "festival",
  "settlement_currency": "USD",
  "kyb_status": "pending_kyb"
}

2. Run KYB

See KYB verification for the full flow. The merchant submits documents and beneficial-owner information through ClearCheck; on approval, kyb_status becomes active.

3. Add locations and terminals

See Locations & terminals. A typical festival creates one location per stage and food court, then registers each scanner under that location with its existing POS/wristband ID.

4. Configure settlement

See Settlement & payouts. The merchant adds a settlement account — a US bank account, a wire account, or a stablecoin destination — and ClearBox schedules payouts on the program’s configured cadence.

What “live” looks like

When a guest taps to pay at a registered terminal, ClearBox runs the authorization flow: the mirror ledger approves in ~0.2 seconds against the guest’s wallet, the merchant’s POS shows success, and the underlying stablecoin settles into the merchant’s settlement account on the configured payout schedule.

Next: KYB verification

Verify the business entity through ClearCheck.