# VirtuaBroker API

> VirtuaBroker API — cross-border payments infrastructure for partners and businesses. Automate quotes, orders, deposits, withdrawals and webhooks over stable JSON contracts.

## Docs

- [VirtuaBroker API — Documentation](https://api.virtuabroker.com/index.md): VirtuaBroker API — cross-border payments infrastructure for partners and businesses. Automate quotes, orders, deposits, withdrawals and webhooks over stable JSON contracts.
- [AML screening — VirtuaBroker API](https://api.virtuabroker.com/aml-screening.md): Screen any person or company against sanctions, PEP and watchlist data through the VirtuaBroker API: instant list checks, identity-rich screenings with stored records, and continuous re-screening of verified accounts.
- [Authentication — VirtuaBroker API](https://api.virtuabroker.com/authentication.md): Authenticate to the VirtuaBroker API with a short-lived OAuth 2.0 bearer token scoped to one workspace: get credentials, request a token, and use it safely.
- [Changelog — VirtuaBroker API](https://api.virtuabroker.com/changelog.md): Notable changes to the VirtuaBroker External API and its documentation, plus the versioning and deprecation policy.
- [API conventions — VirtuaBroker API](https://api.virtuabroker.com/conventions.md): Conventions that hold across the whole VirtuaBroker API: authentication, retrying a write, amounts, rails, timestamps, pagination, rate limits, and response envelopes.
- [Errors — VirtuaBroker API](https://api.virtuabroker.com/errors.md): How the VirtuaBroker API reports errors: a stable machine-readable error type, a human-readable message, and the recommended action for every error type.
- [Get API access — VirtuaBroker](https://api.virtuabroker.com/get-access.md): Request access to the VirtuaBroker API — book an onboarding call with our integrations team (English or Español).
- [Glossary — VirtuaBroker API](https://api.virtuabroker.com/glossary.md): Definitions of the core VirtuaBroker domain terms — workspace, account, entity, quote, order, deposit, trade, withdrawal, and the rest of the platform vocabulary.
- [Identity verification (KYC) — VirtuaBroker API](https://api.virtuabroker.com/kyc-integration.md): Verify your accounts' identity through the VirtuaBroker API: pre-submit the profile data you already hold, launch the hosted verification flow, and track status by polling or webhooks.
- [Payment lifecycle — VirtuaBroker API](https://api.virtuabroker.com/lifecycle.md): How a cross-border payment moves through the VirtuaBroker API: local collection, internal settlement, local payout — and the observable order, deposit, and withdrawal states you track along the way.
- [Quickstart — VirtuaBroker API](https://api.virtuabroker.com/quickstart.md): Make your first cross-border payment with the VirtuaBroker API in five minutes: authenticate, quote, order, and track.
- [Recipe: EUR → BRL payout — VirtuaBroker API](https://api.virtuabroker.com/recipe-eur-brl.md): A complete corridor walkthrough: collect EUR in Spain and pay a Brazilian supplier in BRL via PIX with the VirtuaBroker API — quote, order, fund, and reconcile.
- [Recipe: EUR → USDC payout — VirtuaBroker API](https://api.virtuabroker.com/recipe-eur-usdc.md): A complete crypto-delivery walkthrough: collect EUR over SEPA and pay a counterparty in USDC on-chain with the VirtuaBroker API — quote, order to a wallet, fund, and reconcile.
- [VirtuaBroker API — Reference](https://api.virtuabroker.com/reference.html)
- [VirtuaBroker API — Status](https://api.virtuabroker.com/status.html): Live status of the VirtuaBroker API — quotes, payments, payouts and identity verification.
- [Statuses — VirtuaBroker API](https://api.virtuabroker.com/statuses.md): The observable lifecycle states an integrator sees on VirtuaBroker orders, deposits, withdrawals, and KYC/KYB — with guidance to branch defensively and tolerate additions.
- [Testing & sandbox — VirtuaBroker API](https://api.virtuabroker.com/testing.md): Build and verify your VirtuaBroker integration against the stage environment: environments, a test run, simulating flows, local webhooks, and a go-live checklist.
- [Use cases: what you can build — VirtuaBroker API](https://api.virtuabroker.com/use-cases.md): Every rail VirtuaBroker supports as a payment origin or destination, with the exact request fields for each — payins, payouts, on-ramp, off-ramp, exchange and withdrawals.
- [Webhooks — VirtuaBroker API](https://api.virtuabroker.com/webhooks.md): Subscribe to VirtuaBroker events instead of polling: register an endpoint, verify the X-VirtuaBroker-Signature-256 header, and reconcile deliveries safely.

## API reference

- [OpenAPI specification (JSON)](https://api.virtuabroker.com/openapi.json)
- [OpenAPI specification (YAML)](https://api.virtuabroker.com/openapi.yml)