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.

The ClearBox API is organized around REST. It uses predictable resource-oriented URLs, returns JSON, and uses standard HTTP verbs and status codes.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.clearbox.example.com
Sandboxhttps://sandbox.api.clearbox.example.com

​
Authentication

All requests use a bearer API key in the Authorization header. See Authentication. 
Authorization: Bearer cb_live_...
In the interactive playground (on every endpoint page), paste a sandbox key (cb_sandbox_...) to send live requests against the sandbox.

​
Conventions

  • All request and response bodies are JSON.
  • Timestamps are ISO 8601 in UTC.
  • Amounts are decimal strings (e.g. "100.00") to avoid floating-point errors.
  • Object IDs are prefixed by type (idn_, wlt_, crd_, txn_, mer_, loc_, trm_, stl_).

​
Tags

TagWhat it covers
IdentityCreate and look up verified ClearCheck identities.
WalletsProvision, fund, and read non-custodial wallets.
CardsIssue cards and provision them into Apple Wallet.
MerchantsOnboard merchants, register terminals, configure settlement.
TransactionsRead authorization and settlement records.
The endpoints documented here are ClearBox program endpoints. The full machine-readable spec lives in openapi.json at the root of this repo — replace base URLs and field names with your program’s actual values before publishing.