# Trace Finance

> Explore guides, examples, and API references to build with Trace Finance.

## Docs

- [Create an account](https://tracefinance.mintlify.app/api-reference/fx-account/accounts/create-account.md): Creates a new multi-currency account for the authenticated customer.
- [Get an account](https://tracefinance.mintlify.app/api-reference/fx-account/accounts/get-account.md): Retrieves the details of an account by its ID.
- [List accounts](https://tracefinance.mintlify.app/api-reference/fx-account/accounts/list-accounts.md): Lists all accounts for the authenticated customer with cursor-based pagination.
- [Submit account for review](https://tracefinance.mintlify.app/api-reference/fx-account/accounts/submit-account-for-review.md): Submits an account for compliance review after all requirements are fulfilled.
- [Update an account](https://tracefinance.mintlify.app/api-reference/fx-account/accounts/update-account.md): Replace the owner profile and asset selection for an account that has not been submitted for review yet.
- [Get account balance](https://tracefinance.mintlify.app/api-reference/fx-account/balances/get-balance.md): Retrieves the multi-currency balance for the given account, grouped into fiat and crypto arrays.
- [Add a beneficial owner](https://tracefinance.mintlify.app/api-reference/fx-account/beneficial-owners/add-ubo.md): Adds a beneficial owner (UBO) to a company-owned account.
- [Get a beneficial owner](https://tracefinance.mintlify.app/api-reference/fx-account/beneficial-owners/get-ubo.md): Retrieves a specific beneficial owner by ID.
- [List beneficial owners](https://tracefinance.mintlify.app/api-reference/fx-account/beneficial-owners/list-ubos.md): Lists all beneficial owners for an account.
- [Remove a beneficial owner](https://tracefinance.mintlify.app/api-reference/fx-account/beneficial-owners/remove-ubo.md): Removes a beneficial owner from an account.
- [Update a beneficial owner](https://tracefinance.mintlify.app/api-reference/fx-account/beneficial-owners/update-ubo.md): Updates a beneficial owner using patch semantics. Only provided fields are changed.
- [Upload a document](https://tracefinance.mintlify.app/api-reference/fx-account/documents/upload-document.md): Uploads a document to fulfill an account or beneficial owner requirement.
- [List funding instructions](https://tracefinance.mintlify.app/api-reference/fx-account/funding-instructions/list-funding-instructions.md): Retrieves funding instructions for depositing into an account across all available payment rails.
- [Add a payment instruction](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/add-payment-instruction.md): Adds a payment instruction to an existing beneficiary.
- [Create a beneficiary](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/create-beneficiary.md): Registers a new beneficiary for withdrawals.
- [Delete a beneficiary](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/delete-beneficiary.md): Removes a beneficiary and all its payment instructions.
- [Get a beneficiary](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/get-beneficiary.md): Retrieves the details of a beneficiary by its ID.
- [List beneficiaries](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/list-beneficiaries.md): Lists all beneficiaries for the authenticated customer.
- [Remove a payment instruction](https://tracefinance.mintlify.app/api-reference/fx-payment/beneficiaries/remove-payment-instruction.md): Removes a payment instruction from a beneficiary.
- [Create a deposit](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/create-deposit.md): Creates a deposit and returns the funding instruction the customer should use to send money in.
- [Create a swap](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/create-swap.md): Converts funds between assets within a multi-currency account using a locked quote.
- [Create a transfer](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/create-transfer.md): Moves funds between two accounts of the same customer using a locked quote.
- [Create a withdrawal](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/create-withdrawal.md): Creates a new withdrawal to a saved beneficiary.
- [Get an operation](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/get-operation.md): Retrieves the details of an operation by its ID.
- [List operations](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/list-operations.md): Lists all operations for the authenticated customer.
- [Create a quote](https://tracefinance.mintlify.app/api-reference/fx-payment/operations/quotes/create-quote.md): Locks an FX rate for a short window. Required by every operation creation endpoint.
- [Get a report](https://tracefinance.mintlify.app/api-reference/fx-payment/reports/get-report.md): Aggregated view of operations over a time window, partitioned by asset.
- [Asset activated](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/account/account-asset-activated.md): Fires when an account asset finishes onboarding and funding instructions are available.
- [Asset failed](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/account/account-asset-failed.md): Fires when an account asset's onboarding fails permanently.
- [Account created](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/account/account-created.md): Fires when a new account is created and onboarding starts.
- [Action required](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/account/action-required.md): Fires when a compliance analysis rejects KYC/KYB data and the account is reverted from REVIEWING back to ACTION_REQUIRED.
- [Instruction approved](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/beneficiary/beneficiary-payment-instruction-approved.md): Fires when a payment instruction on a beneficiary is approved. Carries the affected instruction plus beneficiary context.
- [Instruction created](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/beneficiary/beneficiary-payment-instruction-created.md): Fires when a payment instruction is added to a beneficiary; the new instruction starts in PENDING_REVIEW.
- [Instruction rejected](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/beneficiary/beneficiary-payment-instruction-rejected.md): Fires when a payment instruction on a beneficiary is rejected. Carries the affected instruction plus beneficiary context.
- [Completed](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/operation/operation-completed.md): Fires when a payment operation reaches its terminal success state.
- [Failed](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/operation/operation-failed.md): Fires when a payment operation reaches its terminal failure state.
- [Requested](https://tracefinance.mintlify.app/api-reference/fx-webhook/events/operation/operation-requested.md): Fires when a payment operation (deposit, withdrawal, swap) is created.
- [Create a subscription](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/create-subscription.md): Register a webhook subscription for a resource.
- [Delete a subscription](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/delete-subscription.md): Permanently remove a webhook subscription.
- [Get an execution log](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/get-execution-log.md): Retrieve a single webhook delivery attempt.
- [Get a subscription](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/get-subscription.md): Retrieve a single webhook subscription by ID.
- [List execution logs](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/list-execution-logs.md): List delivery attempts for a subscription.
- [List resources and event types](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/list-resource-references.md): Discover the resources and event types available for subscription.
- [List subscriptions](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/list-subscriptions.md): List webhook subscriptions for the authenticated customer.
- [Resend a delivery](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/resend-delivery.md): Re-send a previously failed webhook delivery.
- [Update a subscription](https://tracefinance.mintlify.app/api-reference/fx-webhook/subscriptions/update-subscription.md): Update the URL, event types, description, or status of a subscription.
- [Authentication](https://tracefinance.mintlify.app/guides/authentication.md): Obtain and use JWT tokens to authenticate requests to the Trace Finance API.
- [Beneficiaries](https://tracefinance.mintlify.app/guides/compliance/beneficiaries.md): Sanctions and Travel Rule screening Trace Finance runs on payout recipients, and what the customer keeps responsibility for.
- [BRL named accounts](https://tracefinance.mintlify.app/guides/compliance/brl-named-accounts.md): KYC and KYB requirements for opening BRL named accounts.
- [BRL virtual accounts](https://tracefinance.mintlify.app/guides/compliance/brl-virtual-accounts.md): KYC and KYB requirements for opening Trace Finance-issued BRL virtual accounts.
- [Environments](https://tracefinance.mintlify.app/guides/environments.md): Sandbox and production base URLs, and what differs between them.
- [Date and time](https://tracefinance.mintlify.app/guides/principles/datetime.md): How dates and timestamps are formatted in the API.
- [Errors](https://tracefinance.mintlify.app/guides/principles/errors.md): How errors are structured and how to handle them.
- [Filtering](https://tracefinance.mintlify.app/guides/principles/filtering.md): Refine list results using the filters query parameter.
- [Idempotency](https://tracefinance.mintlify.app/guides/principles/idempotency.md): Use the X-Idempotency-Key header to safely retry requests.
- [Money and currencies](https://tracefinance.mintlify.app/guides/principles/money.md): How monetary amounts are represented in the API.
- [Pagination](https://tracefinance.mintlify.app/guides/principles/pagination.md): Navigate large result sets with cursor-based pagination.
- [Versioning](https://tracefinance.mintlify.app/guides/principles/versioning.md): How API versioning works via the X-Trace-Version header.
- [Testing in sandbox](https://tracefinance.mintlify.app/guides/testing-in-sandbox.md): Magic values and triggers the Trace Finance sandbox accepts to simulate compliance outcomes during homologation.
- [Home](https://tracefinance.mintlify.app/index.md): Explore guides, examples, and API references to build with Trace Finance.
- [Deposit](https://tracefinance.mintlify.app/journeys/deposit.md): Step-by-step guide to crediting an account with a PIX dynamic QR code.
- [Open multi-currency account](https://tracefinance.mintlify.app/journeys/open-multi-currency-account.md): Step-by-step guide to opening an account that holds one or more currencies for an account owner.
- [Register a beneficiary](https://tracefinance.mintlify.app/journeys/register-beneficiary.md): Submit a beneficiary and a payment instruction, then track the compliance review to APPROVED.
- [Swap](https://tracefinance.mintlify.app/journeys/swap.md): Step-by-step guide to converting funds between assets within an account.
- [Transfer](https://tracefinance.mintlify.app/journeys/transfer.md): Step-by-step guide to moving funds between two accounts of the same customer.
- [Withdraw](https://tracefinance.mintlify.app/journeys/withdrawal.md): Step-by-step guide to sending funds from an account to a registered beneficiary.
- [Quickstart](https://tracefinance.mintlify.app/quickstart.md): Make your first API request to Trace Finance in under five minutes.
- [Webhooks](https://tracefinance.mintlify.app/webhooks/overview.md): Receive real-time event notifications from the Trace Finance platform.
- [Retry policy](https://tracefinance.mintlify.app/webhooks/retry-policy.md): How Trace Finance handles failed webhook deliveries, retries, and manual replay.
- [Subscribe to events](https://tracefinance.mintlify.app/webhooks/subscribe.md): Register webhook endpoints, scope event types, and manage subscriptions.
- [Test in sandbox](https://tracefinance.mintlify.app/webhooks/test-in-sandbox.md): Develop and verify webhook handlers against the Trace Finance sandbox.
- [Verify signatures](https://tracefinance.mintlify.app/webhooks/verify-signatures.md): Confirm webhook requests came from Trace Finance with HMAC-SHA256 verification.

## OpenAPI Specs

- [openapi](https://tracefinance.mintlify.app/apis/fx-payment/openapi.yml)