# Crown API Documentation

## Docs

- [Create Sub-Account](https://docs.crown-brlv.com/api-reference/endpoint/v1/accounts/create-account.md): Requests creation of a known-taxpayer individual sub-account under the authenticated partner account. Request-first: the request enters compliance review and the sub-account is provisioned on approval. Requires the manage-holders capability.
- [Get Account](https://docs.crown-brlv.com/api-reference/endpoint/v1/accounts/get-account.md): Fetches a single account by ID. The account must be either the authenticated account itself or one of its sub-accounts (an account whose parent is the caller); any other id is rejected by the access check. Returns the account's profile, status, type, and capabilities.
- [List Accounts](https://docs.crown-brlv.com/api-reference/endpoint/v1/accounts/list-accounts.md): Lists the authenticated account together with its sub-accounts. The caller's own record always comes first, with a null parent-id. Sub-accounts (every account whose parent is the caller, each carrying the caller's id as its parent-id) are included only for callers with the manage-holders capability;…
- [Cancel Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/cancel-auto-claim.md): Cancels a recurring auto-claim schedule and unschedules its job. Requires the auto-claim-rewards capability.
- [Create Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/create-auto-claim.md): Schedules a recurring claim of up to the given amount on a UNIX cron (at least daily) across all of the account's reward certificates. Requires the auto-claim-rewards capability.
- [Skip Auto-Claim](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/create-auto-claim-skip.md): Suppresses the schedule's runs on a single date or across an inclusive date range without deleting it; runs resume automatically after the window. Requires the auto-claim-rewards capability.
- [Create Wallet Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/create-wallet-auto-claim.md): Schedules a recurring claim of up to the given amount on a UNIX cron (at least daily) from reward certificates held by the given wallet address. Requires the auto-claim-rewards capability.
- [Remove Auto-Claim Skip Window](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/delete-auto-claim-skip.md): Deletes a skip window so the schedule runs again on those dates. Requires the auto-claim-rewards capability.
- [Get Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/get-auto-claim.md): Returns a single auto-claim schedule by ID. Requires the auto-claim-rewards capability.
- [List Auto-Claim Skip Windows](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/list-auto-claim-skips.md): Returns the active skip windows for the schedule. Requires the auto-claim-rewards capability.
- [List Auto-Claim Schedules](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/list-auto-claims.md): Returns the account's recurring auto-claim schedules (account- and wallet-scoped). Requires the auto-claim-rewards capability.
- [List Wallet Auto-Claim Schedules](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/list-wallet-auto-claims.md): Returns the recurring auto-claim schedules configured for the given wallet address. Requires the auto-claim-rewards capability.
- [Pause Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/pause-auto-claim.md): Stops a schedule from claiming on its next fires without deleting it; its job stays scheduled so it can be resumed. Requires the auto-claim-rewards capability.
- [Resume Auto-Claim Schedule](https://docs.crown-brlv.com/api-reference/endpoint/v1/auto-claims/resume-auto-claim.md): Re-enables a paused schedule so it claims again on its next fires. Requires the auto-claim-rewards capability.
- [Get Balance by Asset](https://docs.crown-brlv.com/api-reference/endpoint/v1/balance/get-balance.md): Retrieves the account's balance for a given asset.
- [Submit Claim Request](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/create-claim.md): Submits a claim for a specified amount from reward certificates
- [Submit Wallet Claim Request](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/create-wallet-claim.md): Submits a claim for a specified amount from reward certificates held by the given wallet address. FIFO allocation is restricted to certificates at this wallet.
- [List Reward Certificates](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/list-certificates.md): Returns a list of reward certificates with their claimable amounts
- [Get Claimable Balance](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/list-claims.md): Returns the total available balance that can be claimed
- [List Wallet Reward Certificates](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/list-wallet-certificates.md): Returns the reward certificates with their claimable amounts for the given wallet address.
- [Get Wallet Claimable Balance](https://docs.crown-brlv.com/api-reference/endpoint/v1/claims/wallet-claimable-balance.md): Returns the available balance that can be claimed from reward certificates held by the given wallet address.
- [Get Deposit](https://docs.crown-brlv.com/api-reference/endpoint/v1/deposits/get-deposit.md): Retrieves a specific deposit by its ID for the authenticated account. Asset can be 'brl', 'usd', 'usdc' or 'usdt'
- [List Deposits by Asset](https://docs.crown-brlv.com/api-reference/endpoint/v1/deposits/list-deposits.md): Retrieves a list of deposits for the authenticated user for a specific asset type. Asset can be 'brl', 'usd', 'usdc' or 'usdt'
- [Get PIX Deposit QR Code](https://docs.crown-brlv.com/api-reference/endpoint/v1/deposits/pix-deposit.md): Returns the static PIX BR Code used to fund the account's BRL balance: the EMV payload string and a base64-encoded PNG of the QR image.
- [Transfer Reward Certificate NFT](https://docs.crown-brlv.com/api-reference/endpoint/v1/nft-transfers/create-nft-transfer.md): Transfers a reward certificate NFT from a source wallet to a target wallet. Source and target should be EVM wallet addresses (0x...).
- [List Reward Certificate NFT Transfers](https://docs.crown-brlv.com/api-reference/endpoint/v1/nft-transfers/list-nft-transfers.md): Retrieves a list of reward certificate NFT transfers for the authenticated user.
- [Create Order](https://docs.crown-brlv.com/api-reference/endpoint/v1/orders/create-order.md): Creates an order by accepting a quote. Wallet addresses are required only for token assets (eth-base/brlv, eth-mainnet/brlv, eth-base/wbrly). For fiat assets (fiat/brl, fiat/usd), no wallet addresses are needed. Use source-wallet-address for the source wallet and target-wallet-address for the destin…
- [Get Order](https://docs.crown-brlv.com/api-reference/endpoint/v1/orders/get-order.md): Retrieves a specific order by its ID for the authenticated account
- [List Orders](https://docs.crown-brlv.com/api-reference/endpoint/v1/orders/list-orders.md): Retrieves a list of all orders for the authenticated user
- [Create Quote](https://docs.crown-brlv.com/api-reference/endpoint/v1/quotes/create-quote.md): Creates a quote for converting between different assets (fiat currencies and tokens). Either source-amount OR target-amount must be provided, but not both.
- [Get Tax Exemption Progress](https://docs.crown-brlv.com/api-reference/endpoint/v1/tax-exemption/progress.md): Returns the current month's tax exemption progress for Brazilian accounts. Shows the breakdown of disposals that count toward the R$35,000 monthly limit: resgates (claims) and outras alienações (burns and BRLV target-wallet transfers).
- [Transfer Tokens](https://docs.crown-brlv.com/api-reference/endpoint/v1/transfers/create-transfer.md): Transfer tokens from a source wallet to a target wallet. Both source and target should be EVM wallet addresses (0x...).
- [List Transfers](https://docs.crown-brlv.com/api-reference/endpoint/v1/transfers/list-transfers.md): Retrieves a list of token transfers for the authenticated user. Can be filtered by source-address, target-address, asset, or state.
- [Create Wallet](https://docs.crown-brlv.com/api-reference/endpoint/v1/wallets/create-wallet.md): Creates a new wallet with the specified name and default assets (BRLV and wBRLY if applicable).
- [List Wallets](https://docs.crown-brlv.com/api-reference/endpoint/v1/wallets/list-wallets.md): Returns a list of wallets. Can be filtered by assets and/or addresses.
- [Update Wallet Metadata](https://docs.crown-brlv.com/api-reference/endpoint/v1/wallets/update-wallet-metadata.md): Updates the metadata and/or UI visibility for a specific wallet owned by the authenticated user.
- [Create Withdrawal](https://docs.crown-brlv.com/api-reference/endpoint/v1/withdrawals/create-withdrawal.md): Creates a withdrawal for fiat (PIX/TED) or tokens. For fiat BRL, use asset 'fiat/brl' with method 'pix' or 'ted'. For tokens, use asset like 'eth-base/usdc' with method 'token'.
- [Get Withdrawal](https://docs.crown-brlv.com/api-reference/endpoint/v1/withdrawals/get-withdrawal.md): Retrieves details of a specific withdrawal
- [List Withdrawals](https://docs.crown-brlv.com/api-reference/endpoint/v1/withdrawals/list-withdrawals.md): Lists all withdrawals for the authenticated account
- [API Reference](https://docs.crown-brlv.com/api-reference/introduction.md): Complete guide to the Crown API
- [Sub-account Approved](https://docs.crown-brlv.com/api-reference/webhooks/account-approved.md): Triggered when a partner-initiated sub-account creation request clears compliance and the sub-account has been provisioned and activated. Fires on the parent (partner) account's subscriptions.
- [Sub-account Rejected](https://docs.crown-brlv.com/api-reference/webhooks/account-rejected.md): Triggered when a partner-initiated sub-account creation request is not approved (rejected, expired, or cancelled). The reason is intentionally opaque and never discloses sanctions/KYC details. Fires on the parent (partner) account's subscriptions.
- [Claim Completed](https://docs.crown-brlv.com/api-reference/webhooks/claim-completed.md): Triggered when a yield claim has been successfully processed and tokens have been deposited.
- [Deposit Processed](https://docs.crown-brlv.com/api-reference/webhooks/deposit-processed.md): Triggered when a deposit is credited to the account. This covers fiat deposits (BRL via PIX or TED) and crypto deposits. A token (USDC, USDT, or BRLV) transferred into one of the account's wallets is also treated as a deposit, and carries the crypto payload variant with the asset and on-chain addres…
- [Order Completed](https://docs.crown-brlv.com/api-reference/webhooks/order-completed.md): Triggered when a currency conversion order has been successfully completed.
- [Token Transfer Completed](https://docs.crown-brlv.com/api-reference/webhooks/token-transfer-completed.md): Triggered when a token transfer sent from one of the account's wallets completes on-chain. A transfer moves tokens out of one of the account's wallets to a destination wallet.
- [Withdraw Completed](https://docs.crown-brlv.com/api-reference/webhooks/withdraw-completed.md): Triggered when a withdrawal (BRL PIX/TED or token) has been successfully processed and sent.
- [API Keys Setup](https://docs.crown-brlv.com/guides/api-keys-setup.md): Learn how to create and configure API keys for authenticating with the Crown API
- [API Authentication](https://docs.crown-brlv.com/guides/authentication.md): Learn how to authenticate your API requests using JWT tokens
- [Asset Conversions](https://docs.crown-brlv.com/guides/conversions.md): Learn how to convert between different assets using the Crown API
- [Depositing BRL Funds](https://docs.crown-brlv.com/guides/deposits.md): Learn how to deposit Brazilian Real (BRL) into your Crown account
- [Webhooks Setup](https://docs.crown-brlv.com/guides/webhooks-setup.md): Configure webhooks to receive real-time notifications about events in your Crown account
- [Introduction](https://docs.crown-brlv.com/index.md): Welcome to Crown API Documentation
- [BRLV Whitepaper](https://docs.crown-brlv.com/whitepaper.md): BRLV — The Real Standard. A BRL stablecoin backed 1:1 by Brazilian sovereign debt in a bankruptcy-remote structure.

## OpenAPI Specs

- [openapi](https://docs.crown-brlv.com/api-reference/openapi.json)