# ClearBox

## Docs

- [Add Merchant Location](https://docs.clear-box.io/api-reference/add-merchant-location.md): Add a physical or logical location (a stadium, a campus building, a festival stage) under a merchant.
- [Add Settlement Account](https://docs.clear-box.io/api-reference/add-settlement-account.md): Add the bank or stablecoin destination where merchant settlements should arrive.
- [Create Identity](https://docs.clear-box.io/api-reference/create-identity.md): Create a ClearBox identity from a submitted profile. Returns an identity in `pending` status; advance to verified via a ClearCheck inquiry.
- [Create Merchant](https://docs.clear-box.io/api-reference/create-merchant.md): Create a merchant or venue operator. Returns a merchant in `pending_kyb` status; advance to `active` after KYB.
- [Create Wallet](https://docs.clear-box.io/api-reference/create-wallet.md): Provision a non-custodial smart-contract wallet for a verified identity.
- [Fund Wallet](https://docs.clear-box.io/api-reference/fund-wallet.md): Trigger an ACH deposit using a secure processor token from a linked bank.
- [Get Apple Pay Payload](https://docs.clear-box.io/api-reference/get-apple-pay-payload.md): Retrieve the encrypted PassKit payload required by Apple In-App Provisioning to add the card to Apple Wallet. Requires Apple's In-App Provisioning Entitlement on your iOS app.
- [Get Identity](https://docs.clear-box.io/api-reference/get-identity-status.md): Retrieve an identity and its current verification status.
- [Get Transaction](https://docs.clear-box.io/api-reference/get-transaction.md): Retrieve a single transaction with its authorization and settlement state.
- [Get Wallet Balance](https://docs.clear-box.io/api-reference/get-wallet-balance.md): Retrieve a wallet's settled and available balances. Available = settled minus active holds.
- [API Reference](https://docs.clear-box.io/api-reference/introduction.md): The ClearBox REST API. Each endpoint page below includes an interactive playground — set your API key and try requests against the sandbox without leaving the page.
- [Issue Card](https://docs.clear-box.io/api-reference/issue-card.md): Issue a virtual Visa or Mastercard derived from a wallet balance.
- [Register Terminal](https://docs.clear-box.io/api-reference/register-terminal.md): Register a point-of-sale terminal (legacy POS, RIST wristband scanner, mobile reader) to a merchant location. ClearBox bridges the terminal to its stablecoin settlement layer.
- [Apple Pay Provisioning](https://docs.clear-box.io/cards/apple-pay-provisioning.md): Provision a ClearBox card into Apple Wallet using Apple In-App Provisioning, so users can tap to pay without typing a card number.
- [Issue a Virtual Card](https://docs.clear-box.io/cards/issue-a-virtual-card.md): Derive a spendable virtual Visa/Mastercard card from a funded wallet, with spend controls, so users can pay anywhere cards are accepted.
- [Cards Overview](https://docs.clear-box.io/cards/overview.md): Virtual Visa/Mastercard cards derived from a wallet, provisionable into mobile wallets for tap-to-pay.
- [Spend Controls](https://docs.clear-box.io/cards/spend-controls.md): Set per-transaction and interval limits, merchant rules, and freezes on a card.
- [ClearCheck KYC/AML](https://docs.clear-box.io/compliance/clearcheck-kyc.md): ClearBox's compliance model: institutional-grade KYC, AML, and KYB built into the product.
- [Architecture](https://docs.clear-box.io/concepts/architecture.md): The systems that make up a ClearBox integration and how they interact.
- [Glossary](https://docs.clear-box.io/concepts/glossary.md): Key terms used across the ClearBox documentation.
- [The Non-Custodial Model](https://docs.clear-box.io/concepts/non-custodial-model.md): How ClearBox moves value without taking custody of user assets.
- [The Mirror Ledger](https://docs.clear-box.io/concepts/the-mirror-ledger.md): How ClearBox authorizes transactions in real time while the blockchain settles in the background.
- [Authentication](https://docs.clear-box.io/get-started/authentication.md): Authenticate requests to the ClearBox API with bearer API keys.
- [Environments](https://docs.clear-box.io/get-started/environments.md): ClearBox provides isolated sandbox and production environments.
- [Introduction](https://docs.clear-box.io/get-started/introduction.md): ClearBox is the stablecoin settlement hub that verifies, routes, and settles digital transactions at the point of sale. Use these docs to integrate ClearBox into your product.
- [Platform Overview](https://docs.clear-box.io/get-started/platform-overview.md): How ClearBox orchestrates open banking, identity, wallets, cards, and settlement into a single end-to-end flow.
- [Quickstart](https://docs.clear-box.io/get-started/quickstart.md): Onboard a test user, provision a wallet, and run a settled transaction in the ClearBox sandbox.
- [KYB Verification](https://docs.clear-box.io/merchants/kyb-verification.md): Verify a merchant's business entity through ClearCheck KYB — incorporation, beneficial owners, and sanctions screening.
- [Locations & Terminals](https://docs.clear-box.io/merchants/locations-and-terminals.md): Add the venues a merchant operates and register the terminals at each — including legacy POS, wristband scanners, and mobile readers.
- [Merchant Onboarding Overview](https://docs.clear-box.io/merchants/onboarding-overview.md): How a venue operator goes from intake to accepting their first ClearBox-settled transaction.
- [Merchants & Venue Operators](https://docs.clear-box.io/merchants/overview.md): Onboard a merchant or venue operator, register their terminals, and configure where settlements arrive.
- [POS Integrations](https://docs.clear-box.io/merchants/pos-integrations.md): Bridge legacy point-of-sale networks (RIST, Square, Toast) into ClearBox so existing hardware accepts stablecoin settlement without replacement.
- [Reporting](https://docs.clear-box.io/merchants/reporting.md): Reconcile transactions, payouts, and settlement reports for a merchant.
- [Settlement & Payouts](https://docs.clear-box.io/merchants/settlement-payouts.md): Configure where a merchant's settled funds arrive and how often they're paid out.
- [Link a Bank with Quiltt](https://docs.clear-box.io/onboarding/link-a-bank-quiltt.md): Connect a user's bank account through the embedded Quiltt connector, receive the account token, and prepare the verified profile for identity checks.
- [Onboarding Overview](https://docs.clear-box.io/onboarding/overview.md): How a new user goes from signup to a verified, wallet-ready account.
- [Verify Identity (ClearCheck)](https://docs.clear-box.io/onboarding/verify-identity-persona.md): Run an identity verification inquiry through ClearCheck, ClearBox's KYC/AML layer powered by Persona and surfaced through Crossmint Auth.
- [Errors](https://docs.clear-box.io/reference/errors.md): How the ClearBox API reports errors.
- [FAQ](https://docs.clear-box.io/reference/faq.md): Common questions about integrating ClearBox.
- [Status Codes](https://docs.clear-box.io/reference/status-codes.md): HTTP status codes used by the ClearBox API.
- [Authorization & Settlement Flow](https://docs.clear-box.io/settlement/authorization-flow.md): What happens when a user taps to pay: real-time authorization against the mirror ledger, instant approval at the terminal, and asynchronous on-chain settlement.
- [ClearSwap & ClearDEX](https://docs.clear-box.io/settlement/clearswap-and-cleardex.md): The routing engine and private liquidity pool behind ClearBox settlement.
- [Settlement Overview](https://docs.clear-box.io/settlement/overview.md): How ClearBox routes and settles value from any supported asset into merchant finality.
- [Balances](https://docs.clear-box.io/wallets/balances.md): Read a wallet's available and settled balances.
- [Create a Wallet](https://docs.clear-box.io/wallets/create-a-wallet.md): Provision an invisible, non-custodial smart-contract wallet for a verified user and associate it with their ClearBox identity.
- [Fund a Wallet (ACH)](https://docs.clear-box.io/wallets/fund-a-wallet-ach.md): Move fiat into a user's wallet as stablecoin using a bank-transfer authorization and an automated ACH funding flow.
- [Wallets Overview](https://docs.clear-box.io/wallets/overview.md): Invisible, non-custodial smart-contract wallets that hold a user's stablecoin balance.
- [Event Types](https://docs.clear-box.io/webhooks/event-types.md): The webhook events ClearBox sends and when they fire.
- [Webhooks Overview](https://docs.clear-box.io/webhooks/overview.md): Receive real-time notifications when events happen in your ClearBox program.
- [Verifying Signatures](https://docs.clear-box.io/webhooks/verifying-signatures.md): Authenticate that a webhook genuinely came from ClearBox.

## OpenAPI Specs

- [openapi](https://docs.clear-box.io/openapi.json)