# HIFI Docs

> Developer Documentation for HIFI

- [Welcome to HIFI](https://docs.hifi.com/v3/docs/introduction/welcome.md): Infrastructure for modern finance
- [Platform Overview](https://docs.hifi.com/v3/docs/introduction/overview.md): HIFI provides infrastructure for money through three core product pillars: Inflows, Controls, and Outflows.
- [Sandbox](https://docs.hifi.com/v3/docs/introduction/sandbox.md): Our sandbox environment provides a safe testing space to integrate our APIs. All transactions are simulated and hold no real-world value.
- [Developer Dashboard](https://docs.hifi.com/v3/docs/introduction/dashboard.md): The HIFI Developer Dashboard is a web application for managing your keys, data, transactions and settings. Access the same capabilities as the API through an intuitive web interface - no code required.
- [Overview](https://docs.hifi.com/v3/core/users/overview.md): A User represents an individual or business on the HIFI platform. Users are the foundation of all transaction activity - every onramp, offramp, and transfer is associated with a user.
- [Terms of Service](https://docs.hifi.com/v3/core/users/terms-of-service.md): Users must accept HIFI's terms before you can create their account. You have two options for collecting this consent:
- [Overview](https://docs.hifi.com/v3/core/compliance/overview.md): To comply with financial regulations, HIFI enforces KYC (Know Your Customer) and KYB (Know Your Business) checks before a User can receive funds from fiat (onramps), pay out to fiat (offramps), or access other financial products offered by HIFI.
- [KYC](https://docs.hifi.com/v3/core/compliance/kyc.md): To comply with financial regulations, HIFI enforces KYC (Know Your Customer) checks before an individual User can receive funds from fiat (onramps), pay out to fiat (offramps), or access other financial products offered by HIFI.
- [KYB](https://docs.hifi.com/v3/core/compliance/kyb.md): To comply with financial regulations, HIFI enforces KYB (Know Your Business) checks before a business User can receive funds from fiat (onramps), pay out to fiat (offramps), or access other financial products offered by HIFI.
- [Associated Party](https://docs.hifi.com/v3/core/compliance/associated-party.md): For business users, each UBO (ultimate beneficial owner) or person with significant control of the business must be added as an associated party and verified as part of HIFI's KYB check.
- [Questionnaire](https://docs.hifi.com/v3/core/compliance/questionnaire.md): The questionnaire helps our compliance team evaluate a user's expected use cases and volume. It is optional, but providing it can help speed up the compliance review.
- [Documents](https://docs.hifi.com/v3/core/compliance/documents.md): Documentation is uploaded as part of a user's compliance application to satisfy KYC and KYB requirements. Files are uploaded first, then attached to the user (or an associated party) as compliance documents.
- [Compliance Link](https://docs.hifi.com/v3/core/compliance/compliance-link.md): A compliance link is a HIFI-hosted page you can share with your end users to collect their compliance information. Submitted data flows directly to HIFI, so you don't need to handle or store compliance data yourself.
- [Overview](https://docs.hifi.com/v3/core/wallets/overview.md): HIFI Wallets are managed, multi-chain wallets HIFI provisions and secures for each user, alongside external wallets, on-chain deposits, and Canton deposit offers.
- [HIFI Wallet](https://docs.hifi.com/v3/core/wallets/hifi-wallet.md): Provision managed, multi-chain wallets for a user and read their on-chain balances.
- [External Wallet](https://docs.hifi.com/v3/core/wallets/external-wallet.md): Register and manage externally owned wallets used as destinations for onchain operations and onramps, and as the funding source for an offramp.
- [Deposit Offers](https://docs.hifi.com/v3/core/wallets/deposit-offers.md): Accept or reject incoming Canton transfers, which settle as two-step, consent-based offers instead of direct deposits.
- [Overview](https://docs.hifi.com/v3/core/counter-party/overview.md): Represent the people and businesses your users send money and assets to, or receive money and assets from.
- [Counter Party](https://docs.hifi.com/v3/core/counter-party/counterparty.md): Create and manage the individual or business counterparties a user transacts with.
- [External Account](https://docs.hifi.com/v3/core/counter-party/external-account.md): Register and manage bank accounts for a counterparty, used as offramp destinations or onramp funding sources.
- [External Card](https://docs.hifi.com/v3/core/counter-party/external-card.md): Register a debit/prepaid or credit card for a counterparty, directly or through a hosted collection flow.
- [Overview](https://docs.hifi.com/v3/core/transactions/overview.md): Move value between fiat, stablecoins, wallets, and chains.
- [Onramps](https://docs.hifi.com/v3/core/transactions/onramps.md): Convert fiat into stablecoins, funded by a user deposit or an ACH pull from an External Account.
- [Offramps](https://docs.hifi.com/v3/core/transactions/offramps.md): Convert stablecoins into fiat, paid out to a counterparty's External Account or External Card.
- [Onchain Transfer](https://docs.hifi.com/v3/core/transactions/onchain-transfer.md): Move stablecoins between wallets on the same chain - to one recipient, or up to 50 at once.
- [Swap](https://docs.hifi.com/v3/core/transactions/swap.md): Convert between stablecoins held in a HIFI Wallet.
- [Bridge](https://docs.hifi.com/v3/core/transactions/bridge.md): Move a stablecoin from a wallet on one chain to a wallet on a different chain.
- [Overview](https://docs.hifi.com/v3/core/orchestration/overview.md): Standing infrastructure that automatically converts value every time it arrives, instead of a one-off call per transfer.
- [Virtual Accounts](https://docs.hifi.com/v3/core/orchestration/virtual-accounts.md): A persistent USD deposit account - every deposit automatically mints stablecoins to a wallet.
- [Orchestration Address](https://docs.hifi.com/v3/core/orchestration/orchestration-address.md): An Orchestration Address is a persistent on-chain wallet attached to an external account. Stablecoins sent to it are automatically off-ramped to fiat immediately, on a schedule, or when an aggregate amount is reached. The user never has to create an offramp manually; HIFI does it for them.
- [Overview](https://docs.hifi.com/v3/core/eligibility/overview.md): Check which corridors and routes are supported - globally, and for a specific user - before you create a transaction or resource.
- [Corridors](https://docs.hifi.com/v3/core/eligibility/corridors.md): Which fiat ↔ stablecoin combinations are supported for Onramps and Offramps, globally and per user.
- [Virtual Account Routes](https://docs.hifi.com/v3/core/eligibility/virtual-account-routes.md): Which fiat to stablecoin combinations are supported for Virtual Accounts - per user.
- [Overview](https://docs.hifi.com/v3/core/webhooks/overview.md): Get notified in real time as resources change, instead of polling for updates.
- [Webhooks](https://docs.hifi.com/v3/core/webhooks/webhooks.md): Every webhook event type HIFI supports, grouped by resource.
- [Transfer Approvals](https://docs.hifi.com/v3/features/transaction-approval.md): Transfer approvals provide multi-party authorization for transactions, adding security and compliance controls to your organization's transaction workflow. Require approval before executing high-value or sensitive transactions.
- [Developer Fees](https://docs.hifi.com/v3/features/developer-fee.md): Developer Fees enable automated calculation and distribution of fees for offramp transactions. Fees can be configured to be distributed to up to 10 different beneficiary wallets.
- [Settlement Rules](https://docs.hifi.com/v3/features/settlement-rule.md): Automatically split each Virtual Account deposit across multiple wallets, using flat, percentage, or tiered fee calculations.
- [Industries](https://docs.hifi.com/v3/compliance/industries.md): HIFI operates with strict compliance and risk management policies to ensure the safety and integrity of our platform. Certain industries are prohibited or require enhanced due diligence due to regulatory requirements, compliance obligations, and risk management considerations.
- [Regions](https://docs.hifi.com/v3/compliance/regions.md): HIFI operates globally with services available to individuals and businesses all over the world. However, due to regulatory requirements, certain jurisdictions are restricted from using our services.
- [Liveness Checks](https://docs.hifi.com/v3/compliance/liveness-checks.md): Enhanced verification for UBOs or Individuals.
- [Inbound Payment Exceptions](https://docs.hifi.com/v3/payments/exceptions/inbounds.md): How HIFI handles disputes, returns, reversals, and recalls for inbound payments across ACH, Wire, and RTP.
- [Outbound Payment Exceptions](https://docs.hifi.com/v3/payments/exceptions/outbounds.md): How HIFI handles returns, recalls, and refunds for outbound payments when funds cannot be delivered to the recipient.
- [Availability](https://docs.hifi.com/v3/docs/references/availability.md): Processing schedules and cut-off times vary by payment rail. Some rails operate on business days only, while others process 24/7.
- [Coverage](https://docs.hifi.com/v3/docs/references/coverage.md): HIFI enables inflows and outflows across multiple regions. Here are the countries and currencies we support.
- [Onchain Asset Support](https://docs.hifi.com/v3/docs/references/onchain-assets.md): Which chains and stablecoins HIFI Wallets support, and where each currency actually lives on-chain.
- [Account Information](https://docs.hifi.com/v3/docs/references/account-information.md): Which fields are required to add an External Account, by currency, payment rail, and country.
- [Agriculture & Forestry](https://docs.hifi.com/untitled-page.md): Reference table of agriculture and forestry industry codes and classifications.
- [Mining & Energy](https://docs.hifi.com/references/business-industries/mining-energy.md): Reference table of mining and energy industry codes and classifications.
- [Construction](https://docs.hifi.com/references/business-industries/construction.md): Reference table of construction industry codes and classifications.
- [Manufacturing](https://docs.hifi.com/references/business-industries/manufacturing.md): Reference table of manufacturing industry codes and classifications.
- [Wholesale & Retail Trade](https://docs.hifi.com/references/business-industries/wholesale-retail-trade.md): Reference table of wholesale and retail trade industry codes and classifications.
- [Transportation & Logistics](https://docs.hifi.com/references/business-industries/transportation-logistics.md): Reference table of transportation and logistics industry codes and classifications.
- [Information & Media](https://docs.hifi.com/references/business-industries/information-media.md): Reference table of information and media industry codes and classifications.
- [Finance & Insurance](https://docs.hifi.com/references/business-industries/finance-insurance.md): Reference table of finance and insurance industry codes and classifications.
- [Professional & Technical Services](https://docs.hifi.com/references/business-industries/professional-technical-services.md): Reference table of professional and technical services industry codes and classifications.
- [Administrative & Support Services](https://docs.hifi.com/references/business-industries/administrative-support-services.md): Reference table of administrative and support services industry codes and classifications.
- [Real Estate & Leasing](https://docs.hifi.com/references/business-industries/real-estate-leasing.md): Reference table of real estate and leasing industry codes and classifications.
- [Education](https://docs.hifi.com/references/business-industries/education.md): Reference table of education industry codes and classifications.
- [Health & Social Services](https://docs.hifi.com/references/business-industries/health-social-services.md): Reference table of health and social services industry codes and classifications.
- [Arts, Recreation & Entertainment](https://docs.hifi.com/references/business-industries/arts-recreation-entertainment.md): Reference table of arts, recreation and entertainment industry codes and classifications.
- [Hospitality & Food](https://docs.hifi.com/references/business-industries/hospitality-food.md): Reference table of hospitality and food industry codes and classifications.
- [Public Administration](https://docs.hifi.com/references/business-industries/public-administration.md): Reference table of public administration industry codes and classifications.
- [Other Services](https://docs.hifi.com/references/business-industries/other-services.md): Reference table of other services industry codes and classifications.
- [Changelog](https://docs.hifi.com/v3/changelog/changelog.md): Product updates and announcements
- [Authentication](https://docs.hifi.com/v3/apiReference/authentication.md): All requests to the HIFI API must be authenticated using API keys. This guide covers how to create, secure, and manage your keys.
- [Error Codes](https://docs.hifi.com/v3/apiReference/errors.md): When a request fails, the HIFI API returns a JSON body describing what went wrong. This guide covers the error format and how to handle each error type.
- [Ping](https://docs.hifi.com/v3/api-reference/common/ping.md)
- [Create a user](https://docs.hifi.com/v3/api-reference/user/create-a-user.md): Create a new Hifi user.
- [Retrieve a user](https://docs.hifi.com/v3/api-reference/user/retrieve-a-user.md): Retrieve an existing Hifi user.
- [List users](https://docs.hifi.com/v3/api-reference/user/list-users.md): List users for the authenticated profile.
- [Generate a terms of service link](https://docs.hifi.com/v3/api-reference/user/generate-a-terms-of-service-link.md): Generate a hosted Terms of Service link that can be used before creating a user.
- [Retrieve a terms of service link](https://docs.hifi.com/v3/api-reference/user/retrieve-a-terms-of-service-link.md): Retrieve the status of a Terms of Service link.
- [Accept a whitelisted terms of service link](https://docs.hifi.com/v3/api-reference/user/accept-a-whitelisted-terms-of-service-link.md): Accept a Terms of Service link on behalf of a whitelisted signer.
- [Retrieve the compliance profile](https://docs.hifi.com/v3/api-reference/compliance/retrieve-the-compliance-profile.md): Retrieve the compliance (KYC/KYB) profile for a user.
- [Update the compliance profile](https://docs.hifi.com/v3/api-reference/compliance/update-the-compliance-profile.md): Update the compliance (KYC/KYB) profile for a user. The accepted fields depend on whether the user is an individual or a business. All fields are optional on update — only the fields you provide are changed. Sensitive fields (tax ID, phone number) are stored encrypted and returned in full only on th…
- [Retrieve the compliance questionnaire](https://docs.hifi.com/v3/api-reference/compliance/retrieve-the-compliance-questionnaire.md): Retrieve the compliance questionnaire for a user.
- [Update the compliance questionnaire](https://docs.hifi.com/v3/api-reference/compliance/update-the-compliance-questionnaire.md): Update the compliance questionnaire for a user. The accepted fields depend on whether the user is an individual or a business. All fields are optional on update — only the fields you provide are changed.
- [Add an associated party](https://docs.hifi.com/v3/api-reference/compliance/add-an-associated-party.md): Add an associated party (UBO, director, shareholder, etc.) to a business user's compliance profile. `userId` identifies the business user; only it and `roles` are required, and the remaining identity fields may be supplied here or later via update.
- [Update an associated party](https://docs.hifi.com/v3/api-reference/compliance/update-an-associated-party.md): Update an existing associated party. All fields are optional — only the fields you provide are changed.
- [Delete an associated party](https://docs.hifi.com/v3/api-reference/compliance/delete-an-associated-party.md): Delete an associated party. Not allowed if the associated party has already been used in a compliance submission.
- [Retrieve an associated party](https://docs.hifi.com/v3/api-reference/compliance/retrieve-an-associated-party.md): Retrieve details of a specific associated party.
- [List associated parties](https://docs.hifi.com/v3/api-reference/compliance/list-associated-parties.md): List all associated parties for a business user's compliance profile. Cursor-paginated.
- [Add a compliance document](https://docs.hifi.com/v3/api-reference/compliance/add-a-compliance-document.md): Attach a compliance document to a user or to an associated party — exactly one of `userId` or `associatedPartyId` must be provided. The `type` and `subType` values accepted depend on whether the document belongs to an individual or a business (associated parties are always individuals). The document…
- [Update a compliance document](https://docs.hifi.com/v3/api-reference/compliance/update-a-compliance-document.md): Update an existing compliance document. The `type` and `subType` fields cannot be changed; all other fields are optional.
- [Delete a compliance document](https://docs.hifi.com/v3/api-reference/compliance/delete-a-compliance-document.md): Delete a compliance document. Not allowed if the document has already been used in a compliance submission.
- [Retrieve a compliance document](https://docs.hifi.com/v3/api-reference/compliance/retrieve-a-compliance-document.md): Retrieve details of a specific compliance document.
- [List compliance documents](https://docs.hifi.com/v3/api-reference/compliance/list-compliance-documents.md): List all compliance documents for a user or an associated party — exactly one of `userId` or `associatedPartyId` must be provided. Cursor-paginated.
- [Submit compliance for review](https://docs.hifi.com/v3/api-reference/compliance/submit-compliance-for-review.md): Submit the user's compliance profile, questionnaire, documents (and associated parties for business users) for verification. The full submission must satisfy all requirements; if any requirement is unmet, a validation error is returned describing the missing or invalid fields.
- [Retrieve compliance status](https://docs.hifi.com/v3/api-reference/compliance/retrieve-compliance-status.md): Retrieve the current compliance verification status for a user, including the overall compliance status, onboarding status, and any outstanding request-for-information (RFI) actions the user must complete.
- [Generate a compliance link](https://docs.hifi.com/v3/api-reference/compliance/generate-a-compliance-link.md): Generate a hosted compliance (KYC/KYB) link for a user. Exactly one of `userId` or `userType` must be provided. When `userType` is supplied without `userId`, a new user of that type is created and associated with the link.
- [Retrieve a compliance link](https://docs.hifi.com/v3/api-reference/compliance/retrieve-a-compliance-link.md): Retrieve a compliance link by its public ID. Returns the associated user, session token, and the branding template applied to the compliance flow.
- [Upload a file](https://docs.hifi.com/v3/api-reference/file/upload-a-file.md): Upload a file for use in KYC and other verification flows. The file is sent as `multipart/form-data` with a single field named `file`.
- [Create wallets](https://docs.hifi.com/v3/api-reference/wallet/create-wallets.md): Provision HIFI custodial wallets for a user across one or more chains. A user may hold at most one wallet per chain; requesting a chain the user already has a wallet on returns a conflict error.
- [Retrieve a wallet](https://docs.hifi.com/v3/api-reference/wallet/retrieve-a-wallet.md): Retrieve details of a specific HIFI-provisioned wallet.
- [List wallet deposits](https://docs.hifi.com/v3/api-reference/wallet/list-wallet-deposits.md): List inbound deposits received by a specific HIFI-provisioned wallet. `walletId` and `currency` are required. Supports cursor-based pagination and filtering by status, minimum amount, and creation time.
- [Retrieve a wallet deposit](https://docs.hifi.com/v3/api-reference/wallet/retrieve-a-wallet-deposit.md): Retrieve details of a specific wallet deposit.
- [List wallets](https://docs.hifi.com/v3/api-reference/wallet/list-wallets.md): List all HIFI-provisioned wallets for a user.
- [Retrieve a wallet balance](https://docs.hifi.com/v3/api-reference/wallet/retrieve-a-wallet-balance.md): Retrieve the balance of a wallet for a specific currency. Use `GAS` to retrieve the chain's native gas token balance. Returns a not-eligible error if the currency is not supported on the wallet's chain.
- [List offers](https://docs.hifi.com/v3/api-reference/wallet/list-offers.md): List Canton transfer offers directed at a HIFI-provisioned Canton wallet. `walletId` is required. Supports pagination by limit and filtering by creation time.
- [Retrieve an offer](https://docs.hifi.com/v3/api-reference/wallet/retrieve-an-offer.md): Retrieve details of a specific Canton offer.
- [Accept an offer](https://docs.hifi.com/v3/api-reference/wallet/accept-an-offer.md): Accept a Canton transfer offer. The offer must be in `RECEIVED` status and not expired.
- [Reject an offer](https://docs.hifi.com/v3/api-reference/wallet/reject-an-offer.md): Reject a Canton transfer offer. The offer must be in `RECEIVED` status and not expired.
- [Create a counter party](https://docs.hifi.com/v3/api-reference/counter-party/create-a-counter-party.md): Create a new counter party for a user (identified by `userId` in the request body). A counter party represents an external individual or business that funds can be sent to. The `type` field determines whether the counter party is an individual or a business, which determines the required fields.
- [Update a counter party](https://docs.hifi.com/v3/api-reference/counter-party/update-a-counter-party.md): Update fields on an existing counter party.
- [Delete a counter party](https://docs.hifi.com/v3/api-reference/counter-party/delete-a-counter-party.md): Deactivate a counter party. The counter party is marked as inactive and can no longer be used for transfers.
- [Retrieve a counter party](https://docs.hifi.com/v3/api-reference/counter-party/retrieve-a-counter-party.md): Retrieve details of a specific counter party.
- [List counter parties](https://docs.hifi.com/v3/api-reference/counter-party/list-counter-parties.md): List counter parties. Supports cursor-based pagination and filtering by user and type.
- [Create an external account](https://docs.hifi.com/v3/api-reference/external-account/create-an-external-account.md): Create a new external bank account for a counter party (identified by `counterPartyId` in the request body). External accounts represent beneficiary bank accounts where funds can be sent during offramp transfers.
- [Update an external account](https://docs.hifi.com/v3/api-reference/external-account/update-an-external-account.md): Update the nickname on an existing external account.
- [Delete an external account](https://docs.hifi.com/v3/api-reference/external-account/delete-an-external-account.md): Deactivate an external account. The account is marked as inactive and can no longer be used for transfers.
- [Retrieve an external account](https://docs.hifi.com/v3/api-reference/external-account/retrieve-an-external-account.md): Retrieve details of a specific external account.
- [List external accounts](https://docs.hifi.com/v3/api-reference/external-account/list-external-accounts.md): List external accounts. Supports cursor-based pagination and filtering by user, counter party, status, transfer type, and currency.
- [Create an external card](https://docs.hifi.com/v3/api-reference/external-card/create-an-external-card.md): Create a new external card for a counter party (identified by `counterPartyId` in the request body). The card number is tokenized with the card provider and never stored in plaintext; only the last four digits are retained and the card number is always returned masked. The counter party must be acti…
- [Update an external card](https://docs.hifi.com/v3/api-reference/external-card/update-an-external-card.md): Update the nickname on an existing external card.
- [Delete an external card](https://docs.hifi.com/v3/api-reference/external-card/delete-an-external-card.md): Deactivate an external card. The card is marked as inactive and can no longer be used.
- [Retrieve an external card](https://docs.hifi.com/v3/api-reference/external-card/retrieve-an-external-card.md): Retrieve details of a specific external card.
- [List external cards](https://docs.hifi.com/v3/api-reference/external-card/list-external-cards.md): List external cards. Supports cursor-based pagination and filtering by user, counter party, and status.
- [Create an external card session](https://docs.hifi.com/v3/api-reference/external-card/create-an-external-card-session.md): Create a hosted session for collecting a counter party's card details without the card number passing through your backend. Returns a `url` (containing an embedded, single-use session token) to redirect your end user to, or provide `recipientEmail` to have HIFI email it directly.
- [Retrieve an external card session](https://docs.hifi.com/v3/api-reference/external-card/retrieve-an-external-card-session.md): Retrieve the status of an external card session. Restricted to HIFI's hosted session UI; not callable with a client API key.
- [Add an external wallet](https://docs.hifi.com/v3/api-reference/external-wallet/add-an-external-wallet.md): Register an external (client-owned) wallet against a counter party. The `address` must be valid for the specified `chain`. Re-submitting with the same `referenceId` and matching details returns the existing wallet; conflicting details return a conflict error.
- [Update an external wallet](https://docs.hifi.com/v3/api-reference/external-wallet/update-an-external-wallet.md): Update the nickname on an existing external wallet.
- [Deactivate an external wallet](https://docs.hifi.com/v3/api-reference/external-wallet/deactivate-an-external-wallet.md): Deactivate an external wallet. Once deactivated it can no longer be used.
- [Retrieve an external wallet](https://docs.hifi.com/v3/api-reference/external-wallet/retrieve-an-external-wallet.md): Retrieve details of a specific external wallet.
- [List external wallets](https://docs.hifi.com/v3/api-reference/external-wallet/list-external-wallets.md): List external wallets. Supports cursor-based pagination and filtering by user or counter party.
- [Create a virtual account](https://docs.hifi.com/v3/api-reference/virtual-account/create-a-virtual-account.md): Create a virtual account for a user. A virtual account provides bank details that, when funded via fiat, automatically onramp the deposit into a stablecoin delivered to the configured wallet.
- [Retrieve a virtual account](https://docs.hifi.com/v3/api-reference/virtual-account/retrieve-a-virtual-account.md): Retrieve details of a specific virtual account, including deposit instructions and received deposits.
- [Deactivate a virtual account](https://docs.hifi.com/v3/api-reference/virtual-account/deactivate-a-virtual-account.md): Deactivate a virtual account. The account is marked inactive and can no longer receive deposits.
- [List virtual accounts](https://docs.hifi.com/v3/api-reference/virtual-account/list-virtual-accounts.md): List all virtual accounts for a user. Supports cursor-based pagination and filtering by status.
- [Simulate a virtual account deposit](https://docs.hifi.com/v3/api-reference/virtual-account/simulate-a-virtual-account-deposit.md): Sandbox only. Simulates an inbound fiat deposit into the virtual account so the resulting onramp flow can be tested end to end.
- [List virtual account routes](https://docs.hifi.com/v3/api-reference/virtual-account/list-virtual-account-routes.md): List all supported virtual account routes. Supports cursor-based pagination and filtering by status, fiat currency, country, and transfer type.
- [Retrieve a virtual account route](https://docs.hifi.com/v3/api-reference/virtual-account/retrieve-a-virtual-account-route.md): Retrieve details of a specific virtual account route.
- [Create a settlement rule](https://docs.hifi.com/v3/api-reference/virtual-account/create-a-settlement-rule.md): Create a reusable settlement rule that splits incoming virtual-account deposits across destination wallets by percentage or fixed amount.
- [Retrieve a settlement rule](https://docs.hifi.com/v3/api-reference/virtual-account/retrieve-a-settlement-rule.md): Retrieve a specific settlement rule.
- [List settlement rules](https://docs.hifi.com/v3/api-reference/virtual-account/list-settlement-rules.md): List all settlement rules for the authenticated profile.
- [Update a settlement rule](https://docs.hifi.com/v3/api-reference/virtual-account/update-a-settlement-rule.md): Update the rules, chain, or fee handling of a settlement rule.
- [Delete a settlement rule](https://docs.hifi.com/v3/api-reference/virtual-account/delete-a-settlement-rule.md): Delete a settlement rule. It can no longer be applied to virtual accounts.
- [Apply a settlement rule to a virtual account](https://docs.hifi.com/v3/api-reference/virtual-account/apply-a-settlement-rule-to-a-virtual-account.md): Attach a settlement rule to a virtual account so its deposits are split accordingly.
- [Remove the settlement rule from a virtual account](https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account.md): Detach the settlement rule currently applied to a virtual account.
- [Create an orchestration address](https://docs.hifi.com/v3/api-reference/orchestration-address/create-an-orchestration-address.md): Create a persistent address that automatically offramps supported stablecoin deposits.
- [Retrieve an orchestration address](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-addresses.md)
- [Retrieve an orchestration address](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-addresses.md)
- [Update an orchestration address](https://docs.hifi.com/v3/api-reference/orchestration-address/update-an-orchestration-address.md)
- [Deactivate an orchestration address](https://docs.hifi.com/v3/api-reference/orchestration-address/deactivate-an-orchestration-address.md)
- [Retrieve an orchestration deposit](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-deposits.md)
- [Retrieve an orchestration deposit](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-deposits.md)
- [Retrieve an orchestration batch](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-batches.md)
- [Retrieve an orchestration batch](https://docs.hifi.com/v3/api-reference/orchestration-address/list-orchestration-batches.md)
- [Trigger orchestration](https://docs.hifi.com/v3/api-reference/orchestration-address/trigger-orchestration.md): Manually trigger settlement for the address selected by the URL.
- [Get an onramp rate](https://docs.hifi.com/v3/api-reference/onramp/get-an-onramp-rate.md): Retrieve the conversion rate between a source fiat currency and a destination crypto currency.
- [Create an onramp](https://docs.hifi.com/v3/api-reference/onramp/create-an-onramp.md): Create an onramp transaction converting fiat to stablecoins. The source funds either from a user's own account (`source.userId` + `source.transferType`) or from a saved external account (`source.externalAccountId`). The destination delivers crypto to either a HIFI-hosted wallet (`destination.walletI…
- [Accept an onramp quote](https://docs.hifi.com/v3/api-reference/onramp/accept-an-onramp-quote.md): Accept the current quote for an onramp and proceed with the transfer.
- [Retrieve an onramp](https://docs.hifi.com/v3/api-reference/onramp/retrieve-an-onramp.md): Retrieve details of a specific onramp transaction.
- [List onramps](https://docs.hifi.com/v3/api-reference/onramp/list-onramps.md): List all onramps for the authenticated client. Supports cursor-based pagination and filtering by source user, destination user, and status.
- [Cancel an onramp](https://docs.hifi.com/v3/api-reference/onramp/cancel-an-onramp.md): Cancel an onramp that is in review. Only onramps with status `IN_REVIEW` can be cancelled.
- [Simulate an onramp deposit](https://docs.hifi.com/v3/api-reference/onramp/simulate-an-onramp-deposit.md): Simulate an inbound fiat deposit against an onramp. Available in the sandbox environment only; unsupported for onramps not routed through a rail that supports simulation.
- [Retrieve an offramp rate](https://docs.hifi.com/v3/api-reference/offramp/retrieve-an-offramp-rate.md): Retrieve the current conversion rate from a source stablecoin to a destination fiat currency.
- [Create an offramp](https://docs.hifi.com/v3/api-reference/offramp/create-an-offramp.md): Create an offramp transaction that converts stablecoins into fiat and pays out to a beneficiary bank account or card.
- [Accept an offramp quote](https://docs.hifi.com/v3/api-reference/offramp/accept-an-offramp-quote.md): Accept the open quote for an offramp transaction to proceed with the transfer.
- [Retrieve an offramp](https://docs.hifi.com/v3/api-reference/offramp/retrieve-an-offramp.md): Retrieve details of a specific offramp transaction.
- [List offramps](https://docs.hifi.com/v3/api-reference/offramp/list-offramps.md): List all offramp transactions for the authenticated client. Supports cursor-based pagination and filtering by source user, destination user, and status.
- [Cancel an offramp](https://docs.hifi.com/v3/api-reference/offramp/cancel-an-offramp.md): Cancel an offramp that is in review. Only offramps with status `IN_REVIEW` can be cancelled.
- [Create a crypto transfer](https://docs.hifi.com/v3/api-reference/crypto-transfer/create-a-crypto-transfer.md): Create a single crypto transfer that moves a stablecoin from a source wallet to a destination wallet or external wallet. The chain is derived from the source wallet. Provide exactly one of `destination.walletId` or `destination.externalWalletId`.
- [Retrieve a crypto transfer](https://docs.hifi.com/v3/api-reference/crypto-transfer/retrieve-a-crypto-transfer.md): Retrieve details of a specific crypto transfer.
- [List crypto transfers](https://docs.hifi.com/v3/api-reference/crypto-transfer/list-crypto-transfers.md): List all crypto transfers. Supports cursor-based pagination and filtering by status, source user, and destination user.
- [Create a batch crypto transfer](https://docs.hifi.com/v3/api-reference/crypto-transfer/create-a-batch-crypto-transfer.md): Create a batch crypto transfer that moves the same stablecoin from one source wallet to up to 50 destinations, each with its own amount. The chain is derived from the source wallet. Each destination must provide exactly one of `walletId` or `externalWalletId`.
- [Retrieve a batch crypto transfer](https://docs.hifi.com/v3/api-reference/crypto-transfer/retrieve-a-batch-crypto-transfer.md): Retrieve details of a specific batch crypto transfer.
- [List batch crypto transfers](https://docs.hifi.com/v3/api-reference/crypto-transfer/list-batch-crypto-transfers.md): List all batch crypto transfers. Supports cursor-based pagination and filtering by status and source user.
- [Create a swap](https://docs.hifi.com/v3/api-reference/token-swap/create-a-swap.md): Create a token swap. A swap exchanges one stablecoin for another between a source wallet and a destination wallet (owned by a user or an external wallet).
- [Accept a swap quote](https://docs.hifi.com/v3/api-reference/token-swap/accept-a-swap-quote.md): Accept the open quote for a swap and begin execution. The swap must be in `OPEN_QUOTE` status. If the source wallet has insufficient balance, the swap transitions to `QUOTE_FAILED`; otherwise it transitions to `CREATED` and is queued for execution.
- [Retrieve a swap](https://docs.hifi.com/v3/api-reference/token-swap/retrieve-a-swap.md): Retrieve details of a specific swap.
- [List swaps](https://docs.hifi.com/v3/api-reference/token-swap/list-swaps.md): List all swaps. Supports cursor-based pagination and filtering by status, source user, and destination user.
- [Create a bridge transfer](https://docs.hifi.com/v3/api-reference/bridge/create-a-bridge-transfer.md): Create a cross-chain bridge transfer that moves a stablecoin from a source wallet on one chain to a destination wallet (owned or external) on a different chain. The source and destination chains are derived from the wallets referenced and must be different.
- [Retrieve a bridge transfer](https://docs.hifi.com/v3/api-reference/bridge/retrieve-a-bridge-transfer.md): Retrieve details of a specific bridge transfer, including its quote and receipt.
- [Accept a bridge quote](https://docs.hifi.com/v3/api-reference/bridge/accept-a-bridge-quote.md): Accept the open quote on a bridge transfer to begin execution. The bridge must be in the `OPEN_QUOTE` state; a quote that is still being generated (`AWAITING_QUOTE`) or that has expired or is otherwise not acceptable is rejected.
- [List bridge transfers](https://docs.hifi.com/v3/api-reference/bridge/list-bridge-transfers.md): List all bridge transfers for the authenticated client. Supports cursor-based pagination and filtering by status, source user, and destination user.
- [Approve a transfer](https://docs.hifi.com/v3/api-reference/transfer-approval/approve-a-transfer.md): Approve a pending transfer approval. Requires an admin organization role. Returns a conflict error if the approval has already been resolved.
- [Reject a transfer](https://docs.hifi.com/v3/api-reference/transfer-approval/reject-a-transfer.md): Reject a pending transfer approval. Requires an admin organization role. Returns a conflict error if the approval has already been resolved.
- [List transfer approvals](https://docs.hifi.com/v3/api-reference/transfer-approval/list-transfer-approvals.md): List transfer approvals for the authenticated profile. Supports cursor-based pagination and filtering by status.
- [Retrieve a transfer approval](https://docs.hifi.com/v3/api-reference/transfer-approval/retrieve-a-transfer-approval.md): Retrieve details of a specific transfer approval.
- [Retrieve a corridor](https://docs.hifi.com/v3/api-reference/corridor/retrieve-a-corridor.md): Retrieve details of a specific fiat/crypto transfer corridor.
- [List corridors](https://docs.hifi.com/v3/api-reference/corridor/list-corridors.md): List all supported fiat/crypto transfer corridors. Supports cursor-based pagination and filtering by status, fiat currency, fiat country, transfer type, and direction.
- [Map v2 IDs to v3 IDs](https://docs.hifi.com/v3/api-reference/migration/map-v2-ids-to-v3-ids.md): Resolve up to 1000 v2 resource UUIDs to their corresponding v3 public IDs. Entries that cannot be resolved (unknown ID, or a `resourceType` without a migration mapping) are returned with `v3Id: null` and `mapped: false` rather than causing the whole request to fail.
- [List webhook event types](https://docs.hifi.com/v3/api-reference/webhook-endpoint/list-webhook-event-types.md): List all event types that a webhook endpoint can subscribe to.
- [Create a webhook endpoint](https://docs.hifi.com/v3/api-reference/webhook-endpoint/create-a-webhook-endpoint.md): Register a new webhook endpoint. HIFI delivers event notifications to the endpoint's `url` for every event type listed in `subscriptions`.
- [Update a webhook endpoint](https://docs.hifi.com/v3/api-reference/webhook-endpoint/update-a-webhook-endpoint.md): Update a webhook endpoint. Any provided fields replace the existing values. When `subscriptions` is provided it fully replaces the current set of subscribed event types. The signing secret is never returned or rotated by this endpoint.
- [Retrieve a webhook endpoint](https://docs.hifi.com/v3/api-reference/webhook-endpoint/retrieve-a-webhook-endpoint.md): Retrieve details of a specific webhook endpoint. The signing secret is not returned.
- [List webhook endpoints](https://docs.hifi.com/v3/api-reference/webhook-endpoint/list-webhook-endpoints.md): List all webhook endpoints for the authenticated profile. Cursor-paginated.
- [Delete a webhook endpoint](https://docs.hifi.com/v3/api-reference/webhook-endpoint/delete-a-webhook-endpoint.md): Disable a webhook endpoint. The endpoint is marked as disabled and no longer receives event deliveries.
- [Retrieve webhook delivery history](https://docs.hifi.com/v3/api-reference/webhook-endpoint/retrieve-webhook-delivery-history.md): List delivery attempts for a webhook endpoint. Supports cursor-based pagination and filtering by status.
- [Resend a webhook event](https://docs.hifi.com/v3/api-reference/webhook-endpoint/resend-a-webhook-event.md): Re-queue a previously delivered webhook event for redelivery to its endpoint.
- [Welcome to HIFI](https://docs.hifi.com/index.md): Infrastructure for money
- [Platform Overview](https://docs.hifi.com/overview.md): HIFI provides infrastructure for money through three core product pillars: Inflows, Controls, and Outflows.
- [Sandbox](https://docs.hifi.com/sandbox.md): Our sandbox environment provides a safe testing space to integrate our APIs. All transactions are simulated and hold no real-world value.
- [Dashboard](https://docs.hifi.com/dashboard.md): The HIFI Dashboard is a web application for managing your keys, data, transactions and settings. Access the same capabilities as the API through an intuitive web interface—no code required.
- [Availability](https://docs.hifi.com/availability.md): We operate on weekdays - Monday through Friday, excluding Federal Reserve holidays (for USD transactions).
- [Coverage](https://docs.hifi.com/coverage.md): HIFI enables inflows and outflows across multiple regions. Here are the countries and currencies we support by rail.
- [Overview](https://docs.hifi.com/users/overview.md): A User represents an individual or business on the HIFI platform. Users are the foundation of all transaction activity - every onramp, offramp, and transfer is associated with a user.
- [Terms of Service](https://docs.hifi.com/users/tos.md): Users must accept HIFI's terms before you can create their account. You have two options for collecting this consent:
- [Wallets](https://docs.hifi.com/wallets.md): A Wallet is a cryptocurrency account that holds and moves digital assets on the HIFI platform. Every wallet belongs to a user and can hold balances in supported stablecoins across multiple blockchain networks.
- [Overview](https://docs.hifi.com/kyc.md): To comply with financial regulations, HIFI enforces KYC (Know Your Customer) and KYB (Know Your Business) checks before a User can receive funds from fiat (onramps) or pay out to fiat (offramps).
- [KYC Requirements](https://docs.hifi.com/kyc/kyc-requirements.md): The KYC Requirements endpoint tells you exactly which data points and documents are needed to unlock a given rail for a specific user.
- [KYC Status](https://docs.hifi.com/kyc/kyc-status.md): Use the KYC Status endpoint to check where a user's verification stands, diagnose issues, and confirm when they're ready to use a rail.
- [KYB Status](https://docs.hifi.com/kyc/kyb-status.md): To check where a business's verification stands, diagnose issues, and confirm when they're ready to use a rail, use the [KYC Status endpoint](https://docs.hifi.com/api-reference/kyc/retrieve-kyc-status). This guide focuses on interpreting the business-specific response.
- [About Rails](https://docs.hifi.com/rails.md): Unlocking a Rail enables a user's access to specific payment networks and geographic regions.
- [USD Rail](https://docs.hifi.com/rails/usd.md): The USD Rail enables pay-ins and pay-outs from stablecoins to USD. It also enables Virtual Accounts for recurring payments.
- [Global Network Rail](https://docs.hifi.com/rails/global-network.md): The Global Network Rail enables payouts across multiple regions with support for multiple currencies.
- [Africa Rail (Beta)](https://docs.hifi.com/rails/africa.md): The Africa Rail (beta) enables local currency pay-ins and pay-outs across multiple African countries through bank transfers and mobile money.
- [Virtual Accounts](https://docs.hifi.com/accounts/virtual-accounts.md): A Virtual Account is a dedicated bank account that automatically converts fiat deposits into stablecoins. When users send money to a virtual account via bank transfer, the funds are instantly converted to stablecoins and delivered to their wallet.
- [Offramp Accounts](https://docs.hifi.com/accounts/offramp-accounts.md): An Offramp Account is a user's external bank account where they receive fiat money from stablecoin conversions. When users offramp, their stablecoins are converted to fiat and sent directly to this registered account.
- [Onramp Accounts](https://docs.hifi.com/accounts/onramp-accounts.md): An Onramp Account is a one-time generated account for a single onramp transaction. When you create an onramp, HIFI generates unique deposit details (bank account and reference ID) for that transaction; the user sends fiat to that account and receives stablecoins.
- [Overview](https://docs.hifi.com/transactions/overview.md): HIFI supports five types of transactions: transfers, onramps, offramps, bridging, and swaps. Each type serves a distinct purpose for moving value between wallets, fiat, and chains.
- [Transfers](https://docs.hifi.com/transactions/transfers.md): Wallet transfers allow you to send stablecoins between wallets on blockchain networks. Transactions can be sent to other HIFI users or external wallet addresses.
- [Onramps](https://docs.hifi.com/transactions/onramps.md): Onramps convert fiat currency into stablecoins and deliver them to wallets. Users can onramp through virtual accounts (reusable) or the Onramp API (one-time virtual accounts).
- [Offramps](https://docs.hifi.com/transactions/offramps.md): Offramps convert stablecoins into fiat currency and send it to external bank accounts. Users must accept a quote before the conversion executes.
- [Bridging](https://docs.hifi.com/transactions/bridging.md): Bridging transfers stablecoins across different blockchain networks. Move assets from one chain to another, such as transferring USDC from Ethereum to Polygon or Solana.
- [Swaps](https://docs.hifi.com/transactions/swaps.md): Swaps let you exchange one stablecoin for another within HIFI wallets. All swaps follow a two-step process: create the swap request, then accept it to execute the exchange.
- [Events & Webhooks](https://docs.hifi.com/webhooks.md): Webhooks deliver real-time event notifications from HIFI to your application. When events occur in your HIFI account, HIFI sends HTTP POST requests to your registered webhook endpoints, enabling your systems to respond immediately.
- [User Events](https://docs.hifi.com/webhooks/user-events.md): You can expect to receive webhook events whenever you successfully create or update a user.
- [KYC Events](https://docs.hifi.com/webhooks/kyc-events.md): You can expect to receive KYC webhook events whenever you update a user's KYC data, submit KYC to unlock a rail, or receive KYC status updates for any rail you've submitted.
- [Wallet Events](https://docs.hifi.com/webhooks/wallet-events.md): You can expect to receive webhook events whenever you successfully initiate a wallet transfer, bridge assets, or update a wallet token balance.
- [Swap Events](https://docs.hifi.com/webhooks/onramp-events-copied-1.md): You can expect to receive webhook events whenever an token swap is created or its status is updated.
- [Account Events](https://docs.hifi.com/webhooks/account-events.md): You can expect to receive webhook events whenever an account is successfully created.
- [Onramp Events](https://docs.hifi.com/webhooks/onramp-events.md): You can expect to receive webhook events whenever an onramp transfer is created or its status is updated.
- [Offramp Events](https://docs.hifi.com/webhooks/offramp-events.md): You can expect to receive webhook events whenever an offramp transfer is created or its status is updated.
- [Metrics](https://docs.hifi.com/reporting/metrics.md): Track transaction volume, activity patterns, and user growth with configurable metrics. Build custom views using templates, apply filters, and break down data by dimensions like transaction type or user.
- [Overview](https://docs.hifi.com/features/magic-values/overview.md)
- [Offramp](https://docs.hifi.com/features/magic-values/offramp.md): Use magic values in sandbox to force an offramp into a particular outcome, so you can test how your integration handles failures and returns.
- [Onramp](https://docs.hifi.com/features/magic-values/onramp.md): Use magic values in sandbox to force an onramp into a particular outcome, so you can test how your integration handles failures and returns.
- [Submit KYC](https://docs.hifi.com/features/magic-values/submit-kyc.md): Use magic values in sandbox to drive a KYC application to a particular status, so you can test how your integration handles each outcome.
- [Overview](https://docs.hifi.com/features/canton/overview.md)
- [Transfer Offer](https://docs.hifi.com/features/canton/transfer-offer.md)
- [USDCx Bridging](https://docs.hifi.com/features/canton/usdcx-bridging.md)
- [KYC Links](https://docs.hifi.com/features/kyc-links.md): KYC Links enable you to collect Know Your Customer (KYC) information from users through a secure, hosted flow. Use KYC links to create a user, unlock rails for a user, or submit KYC for a user.
- [Exchange Rates](https://docs.hifi.com/features/exchange-rates.md): Exchange Rates provide estimated conversion rates for transactions between stablecoins and fiat. Use these rates to display pricing information to users before creating offramp or onramp requests.
- [Batch Transfers](https://docs.hifi.com/features/batch-transfers.md): Batch transfers send stablecoins to up to 50 recipients in a single blockchain transaction. This reduces gas costs and simplifies bulk distributions like payroll, airdrops, or rewards.
- [Transfer Approvals](https://docs.hifi.com/features/transfer-approvals.md): Transfer approvals provide multi-party authorization for transactions, adding security and compliance controls to your organization's transaction workflow. Require approval before executing high-value or sensitive transactions.
- [Developer Fees](https://docs.hifi.com/features/developer-fees.md): Developer Fees enable automated calculation and distribution of fees for offramp transactions. Fees can be configured to be distributed to up to 10 different beneficiary wallets.
- [Settlement Rules](https://docs.hifi.com/features/settlement-rules.md): Settlement Rules allow you to configure automated fee calculations and distributions for Virtual Account transactions. Automatically deduct fees using fixed amounts, percentages, or tiered pricing models, and send them to specified wallet addresses.
- [Orchestration Addresses](https://docs.hifi.com/features/orchestration-addresses.md): An Orchestration Address is a persistent on-chain wallet attached to a USD payout account. Stablecoins sent to it are automatically off-ramped to fiat — immediately, on a schedule, or when an aggregate amount is reached. The user never has to create an offramp manually; HIFI does it for them.
- [KYC Token Import (Beta)](https://docs.hifi.com/features/token-sharing.md): KYC Token Import allows you to onboard users who have already completed identity verification with Sumsub on your platform. Share their existing KYC directly into HIFI without requiring users to re-submit their information.
- [Industries](https://docs.hifi.com/compliance/industries.md): HIFI operates with strict compliance and risk management policies to ensure the safety and integrity of our platform. Certain industries are prohibited or require enhanced due diligence due to regulatory requirements, compliance obligations, and risk management considerations.
- [Regions](https://docs.hifi.com/compliance/regions.md): HIFI operates globally with services available to individuals and businesses all over the world. However, due to regulatory requirements, certain jurisdictions are restricted from using our services.
- [Liveness Checks](https://docs.hifi.com/compliance/liveness-checks.md): Enhanced verification for UBOs.
- [Documents](https://docs.hifi.com/compliance/documents.md): Documents enable programmatic upload and management of KYC verification documents. Upload identity documents, proof of address, and business documents through the Documents API.
- [ID Verification](https://docs.hifi.com/compliance/documents/identity.md): Identity documents are required for KYC verification. The accepted document types and requirements vary by country. Use the [Identity Documents](/docs/references/identity-documents) reference to determine which documents are accepted for each country and their required subtypes.
- [Proof of Address](https://docs.hifi.com/compliance/documents/proof-of-address.md): Proof of Address (PoA) documents are required to verify a user's residential or business address. Requirements differ for individual and business users.
- [ACH Disputes](https://docs.hifi.com/disputes.md)
- [Currencies](https://docs.hifi.com/references/currencies.md): With HIFI, you can convert fiat currencies into stablecoins and vice versa using various local payment methods. This page outlines supported currencies and payment methods across regions.
- [Identity Documents](https://docs.hifi.com/references/identity-documents.md): Reference table of supported government-issued identity documents by country and document type.
- [business-industries](https://docs.hifi.com/references/business-industries.md)
- [Agriculture & Forestry](https://docs.hifi.com/references/business-industries/agriculture-forestry.md): Reference table of agriculture and forestry industry codes and classifications.
- [Mining & Energy](https://docs.hifi.com/references/business-industries/mining-energy.md): Reference table of mining and energy industry codes and classifications.
- [Construction](https://docs.hifi.com/references/business-industries/construction.md): Reference table of construction industry codes and classifications.
- [Manufacturing](https://docs.hifi.com/references/business-industries/manufacturing.md): Reference table of manufacturing industry codes and classifications.
- [Wholesale & Retail Trade](https://docs.hifi.com/references/business-industries/wholesale-retail-trade.md): Reference table of wholesale and retail trade industry codes and classifications.
- [Transportation & Logistics](https://docs.hifi.com/references/business-industries/transportation-logistics.md): Reference table of transportation and logistics industry codes and classifications.
- [Information & Media](https://docs.hifi.com/references/business-industries/information-media.md): Reference table of information and media industry codes and classifications.
- [Finance & Insurance](https://docs.hifi.com/references/business-industries/finance-insurance.md): Reference table of finance and insurance industry codes and classifications.
- [Real Estate & Leasing](https://docs.hifi.com/references/business-industries/real-estate-leasing.md): Reference table of real estate and leasing industry codes and classifications.
- [Professional & Technical Services](https://docs.hifi.com/references/business-industries/professional-technical-services.md): Reference table of professional and technical services industry codes and classifications.
- [Administrative & Support Services](https://docs.hifi.com/references/business-industries/administrative-support-services.md): Reference table of administrative and support services industry codes and classifications.
- [Education](https://docs.hifi.com/references/business-industries/education.md): Reference table of education industry codes and classifications.
- [Health & Social Services](https://docs.hifi.com/references/business-industries/health-social-services.md): Reference table of health and social services industry codes and classifications.
- [Arts, Recreation & Entertainment](https://docs.hifi.com/references/business-industries/arts-recreation-entertainment.md): Reference table of arts, recreation and entertainment industry codes and classifications.
- [Hospitality & Food](https://docs.hifi.com/references/business-industries/hospitality-food.md): Reference table of hospitality and food industry codes and classifications.
- [Other Services](https://docs.hifi.com/references/business-industries/other-services.md): Reference table of other services industry codes and classifications.
- [Public Administration](https://docs.hifi.com/references/business-industries/public-administration.md): Reference table of public administration industry codes and classifications.
- [Individual Occupations](https://docs.hifi.com/references/occupations.md): Reference table of supported occupation titles and codes for individuals. Useful for KYC and onboarding forms.
- [Account Purposes](https://docs.hifi.com/references/account-purposes.md): Reference for acceptable account purpose values and their descriptions
- [Export Categories](https://docs.hifi.com/references/export-categories.md): Reference table listing export categories and their codes.
- [Product & Service Categories](https://docs.hifi.com/references/product-service-categories.md): Reference table of product and service categories with their corresponding item codes for business classification.
- [Quickstart](https://docs.hifi.com/guides/quickstart.md): In this guide, you'll learn how to use the HIFI Sandbox API to simulate money movement. You'll create users, complete KYC, set up a virtual account, simulate a deposit to fund a wallet, and execute a transfer between wallets.
- [Submit KYC](https://docs.hifi.com/guides/submit-kyc.md): This guide shows you how to submit KYC (Know Your Customer) information programmatically using the HIFI API. Users must complete KYC verification to unlock rails (payment corridors that enable currency conversions between fiat and stablecoins).
- [Liveness Checks](https://docs.hifi.com/guides/liveness-checks.md): Show UBOs the hosted liveness check required to enable USD virtual accounts.
- [Receive Money](https://docs.hifi.com/guides/receive-money.md): This guide shows you how to receive money - converting fiat currency (like USD) into stablecoins (like USDC) and depositing them into a user's wallet.
- [Send Money](https://docs.hifi.com/guides/send-money.md): This guide shows you how to send money - converting stablecoins (like USDC) into fiat currency (like USD) and sending it to a user's bank account.
- [Send EUR Offramps](https://docs.hifi.com/guides/send-eur-offramps.md): Settle stablecoins to EUR through SEPA.
- [Reporting](https://docs.hifi.com/guides/reporting.md): Learn how to use the Metrics API with detailed examples. This guide covers common patterns, step-by-step workflows, and code samples for tracking transaction volume, activity patterns, and user growth.
- [Remittances](https://docs.hifi.com/guides/remittances.md): Build remittance products that enable users to send money home to family and friends across borders. Our platform provides the infrastructure you need to create seamless, compliant international money transfer experiences.
- [Global Transfers](https://docs.hifi.com/guides/global-transfers.md): Enable businesses to send money internationally through stablecoins with instant settlement. Leverage HIFI's global network to reach recipients in multiple countries with low fees and transparent exchange rates.
- [Marketplace Payments](https://docs.hifi.com/guides/market-payments.md): Facilitate marketplace payments where buyers can pay sellers across regions and currencies, with structured payout flows that reflect how modern marketplaces operate. Support common marketplace behaviors such as holding funds until conditions are met, confirming completed orders, and releasing payou…
- [Split Payments](https://docs.hifi.com/guides/split-payments.md): Facilitate split payment services where a single payment is divided among multiple recipients. Perfect for splitting bills, shared expenses, or distributing funds to multiple stakeholders efficiently.
- [Changelog](https://docs.hifi.com/changelog.md): Product updates and announcements
- [Authentication](https://docs.hifi.com/api/authentication.md): All requests to the HIFI API must be authenticated using API keys. This guide covers how to create, secure, and manage your keys.
- [Error Codes](https://docs.hifi.com/api/errors.md): This document provides a comprehensive guide to the error handling system used in the HIFI API. Understanding these error codes will help you effectively handle exceptions and communicate issues to your users.
- [Ping](https://docs.hifi.com/api-reference/common/ping.md)
- [List all users](https://docs.hifi.com/api-reference/user/list-all-users.md): Get all existing Hifi users
- [Retrieve a user](https://docs.hifi.com/api-reference/user/retrieve-a-user.md): Get an existing Hifi user
- [Create a user](https://docs.hifi.com/api-reference/user/create-a-user.md): Create a new Hifi user (Individual/Business)
- [Update a user](https://docs.hifi.com/api-reference/user/update-a-user.md): Update an existing Hifi user.
- [Retrieve a terms of service link](https://docs.hifi.com/api-reference/user/retrieve-a-terms-of-service-link.md): Retrieve the status of a terms of service link
- [Generate a terms of service link](https://docs.hifi.com/api-reference/user/generate-a-terms-of-service-link.md): The Terms of Service page must be displayed to the end user. This page can be whitelabeled upon request.
- [List all KYC statuses](https://docs.hifi.com/api-reference/kyc/list-all-kyc-statuses.md): List all KYC statuses based on the provided filters.
- [Retrieve KYC information](https://docs.hifi.com/api-reference/kyc/retrieve-kyc-information.md): Get the KYC information the user currently holds.
- [Retrieve KYC status](https://docs.hifi.com/api-reference/kyc/retrieve-kyc-status.md): Get the user's latest KYC status for a specific rail after a KYC submission. If no KYC submission has been made for the rail, it will have an `INACTIVE` status.
- [Retrieve KYC requirements](https://docs.hifi.com/api-reference/kyc/retrieve-kyc-requirements.md): Get the required and optional KYC fields for a specific rail, along with any invalid KYC fields currently held by the user for unlocking the rail.
- [List all documents](https://docs.hifi.com/api-reference/kyc/list-all-documents.md): Get all documents associated with the user.
- [Retrieve a document](https://docs.hifi.com/api-reference/kyc/retrieve-a-document.md): Get a specific document associated with the user or ubo.
- [List all UBOs](https://docs.hifi.com/api-reference/kyc/list-all-ubos.md): Get all UBOs associated with the user.
- [Retrieve a UBO](https://docs.hifi.com/api-reference/kyc/retrieve-a-ubo.md): Get a specific UBO associated with the user.
- [Generate a KYC link](https://docs.hifi.com/api-reference/kyc/generate-a-kyc-link.md): Generate a KYC link to create a user, unlock rails for a user, or submit KYC for a user.
- [Update KYC information](https://docs.hifi.com/api-reference/kyc/update-kyc-information.md): Update the user's KYC information.
- [Submit KYC](https://docs.hifi.com/api-reference/kyc/submit-kyc.md): Submit the user's current KYC data to unlock a specific rail. Any updates to the user's KYC data prior to submission should be made using the [Update KYC](https://docs.hifi.com/api-reference/kyc/update-kyc-information) endpoint.)
- [Add documents](https://docs.hifi.com/api-reference/kyc/add-documents.md): Add documents to the user's KYC.
- [Update a document](https://docs.hifi.com/api-reference/kyc/update-a-document.md): Update a document for the user.
- [Add a UBO](https://docs.hifi.com/api-reference/kyc/add-a-ubo.md): Add a UBO to the user.
- [Update a UBO](https://docs.hifi.com/api-reference/kyc/update-a-ubo.md): Update a UBO for the user.
- [Upload a file](https://docs.hifi.com/api-reference/file/upload-a-file.md): Upload a file.
- [Retrieve wallet balance](https://docs.hifi.com/api-reference/wallet/retrieve-wallet-balance.md): Get the latest balance of a user's wallet, including details like the blockchain network and currency.
- [Get external wallets for a user](https://docs.hifi.com/api-reference/wallet/get-external-wallets-for-a-user.md): Get external wallets for a user
- [Get an external wallet](https://docs.hifi.com/api-reference/wallet/get-an-external-wallet.md): Get an external wallet
- [Get inbound deposits](https://docs.hifi.com/api-reference/wallet/get-inbound-deposits.md): Get inbound deposits for a user's wallet
- [Get an inbound deposit](https://docs.hifi.com/api-reference/wallet/get-an-inbound-deposit.md): Get an inbound deposit for a user's wallet
- [Add wallets to a user](https://docs.hifi.com/api-reference/wallet/add-wallets-to-a-user.md): Add wallets to a user
- [Add external wallets to a user](https://docs.hifi.com/api-reference/wallet/add-external-wallets-to-a-user.md): Add external wallets to a user
- [List all accounts](https://docs.hifi.com/api-reference/account/list-all-accounts.md): List all accounts associated with a user under your organization.
- [Retrieve an account](https://docs.hifi.com/api-reference/account/retrieve-an-account.md): Get an existing onramp or offramp account detail.
- [Create an account](https://docs.hifi.com/api-reference/account/create-an-account.md): Create an onramp or offramp account for different account types by providing your bank account information.
- [Delete an account](https://docs.hifi.com/api-reference/account/delete-an-account.md): Delete an existing onramp or offramp account.
- [List all virtual accounts](https://docs.hifi.com/api-reference/virtual-account/list-all-virtual-accounts.md): List all virtual accounts associated with a user under your organization.
- [Retrieve a virtual account](https://docs.hifi.com/api-reference/virtual-account/retrieve-a-virtual-account.md): Get an existing virtual bank account detail.
- [Create a virtual account](https://docs.hifi.com/api-reference/virtual-account/create-a-virtual-account.md): Generate a virtual bank account to onramp from `sourceCurrency` to `destinationCurrency` on chain `destinationChain`. (note: virtual accounts are billable)
- [Update a virtual account](https://docs.hifi.com/api-reference/virtual-account/update-a-virtual-account.md): Update an existing virtual account.
- [Deactivate a virtual account](https://docs.hifi.com/api-reference/virtual-account/deactivate-a-virtual-account.md): Deactivate an existing virtual account.
- [Reactivate a virtual account](https://docs.hifi.com/api-reference/virtual-account/reactivate-a-virtual-account.md): Reactivate an existing virtual account.
- [Simulate a deposit to a virtual account](https://docs.hifi.com/api-reference/virtual-account/simulate-a-deposit-to-a-virtual-account.md): Simulate a deposit to a virtual account in sandbox environment. This endpoint is only available in sandbox and allows testing deposit flows.
- [List orchestration addresses](https://docs.hifi.com/api-reference/orchestration-address/list-orchestration-addresses.md): Return all orchestration addresses owned by the user, most recent first. Includes both `ACTIVE` and `DEACTIVATED` addresses.
- [Retrieve an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/retrieve-an-orchestration-address.md): Fetch a single orchestration address by ID. Returns `404 RESOURCE_NOT_FOUND` if the address doesn't exist *or* doesn't belong to the specified user — the API never discloses whether a foreign address exists.
- [Create an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/create-an-orchestration-address.md): Create a persistent on-chain wallet that automatically offramps any stablecoin deposit to a USD bank account.
- [Update an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/update-an-orchestration-address.md): Partial update of an existing orchestration address. Any combination of `mode`, `schedule`, `thresholdAmount`, and `destination.accountId` may be passed.
- [Deactivate an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/deactivate-an-orchestration-address.md): Soft-delete the address: sets `status=DEACTIVATED` and `deactivatedAt=now()`. Requires a `walletAddress` in the body — any deposits still `PENDING` (not yet rolled into a batch) are refunded in-kind to it. The claim and refund run atomically under the address row lock, so a deposit can never be both…
- [List deposits for an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/list-deposits-for-an-orchestration-address.md): List on-chain deposits detected for the address, most recent first. Filterable by status, batch ID, and a created-at window.
- [Retrieve a deposit](https://docs.hifi.com/api-reference/orchestration-address/retrieve-a-deposit.md): Fetch a single deposit by ID. Returns `404 RESOURCE_NOT_FOUND` if the deposit doesn't exist, doesn't belong to the named orchestration address, or the orchestration address doesn't belong to the named user.
- [List batches for an orchestration address](https://docs.hifi.com/api-reference/orchestration-address/list-batches-for-an-orchestration-address.md): List batches produced from this address's deposits. Each batch carries the IDs of the deposits it rolled up and (once the worker runs) the `offrampTransactionId` of the produced offramp.
- [Retrieve a batch](https://docs.hifi.com/api-reference/orchestration-address/retrieve-a-batch.md): Fetch a single batch by ID. Returns `404 RESOURCE_NOT_FOUND` if the batch doesn't exist, doesn't belong to the named orchestration address, or the orchestration address doesn't belong to the named user.
- [Manually trigger an orchestration](https://docs.hifi.com/api-reference/orchestration-address/manually-trigger-an-orchestration.md): Force an immediate batch of all currently-`PENDING` deposits for the address, regardless of the configured mode. Useful for `SCHEDULED` addresses that you want to drain ahead of schedule, for `THRESHOLD` addresses that haven't crossed yet, or simply for operational backfill.
- [List all onramps](https://docs.hifi.com/api-reference/onramp/list-all-onramps.md): Returns a list of onramps associated with a user under your organization. The onramps are returned sorted by creation date, with the most recent onramps appearing first.
- [Retrieve an onramp](https://docs.hifi.com/api-reference/onramp/retrieve-an-onramp.md): Retrieves an onramp.
- [Retrieve an onramp rate](https://docs.hifi.com/api-reference/onramp/retrieve-an-onramp-rate.md): Onramp rates are estimated rates for onramp conversions from different fiat currencies into different cryptocurrencies.
- [Create an onramp](https://docs.hifi.com/api-reference/onramp/create-an-onramp.md): An onramp facilitates the conversion of fiat to crypto. Once the fiat payment is received, HIFI will deliver the converted crypto to the receiving user’s wallet.
- [Cancel an onramp](https://docs.hifi.com/api-reference/onramp/cancel-an-onramp.md): Cancel an onramp that is in review. Only onramps with status `IN_REVIEW` can be cancelled.
- [Refresh an onramp quote](https://docs.hifi.com/api-reference/onramp/refresh-an-onramp-quote.md): Refresh the conversion rate quote that is associated with a quote-based onramp. You can only refresh an onramp quote with the status `OPEN_QUOTE`.
- [Accept an onramp quote](https://docs.hifi.com/api-reference/onramp/accept-an-onramp-quote.md): Accept a quote-based onramp.
- [List all offramps](https://docs.hifi.com/api-reference/offramp/list-all-offramps.md): Returns a list of offramps associated with a user under your organization. The offramps are returned sorted by creation date, with the most recent offramps appearing first.
- [Retrieve an offramp](https://docs.hifi.com/api-reference/offramp/retrieve-an-offramp.md): Retrieves an offramp.
- [Retrieve an offramp rate](https://docs.hifi.com/api-reference/offramp/retrieve-an-offramp-rate.md): Offramp rates are estimated rates for offramp conversions from different cryptocurrencies on different networks into all the different fiat currencies.
- [Create an offramp](https://docs.hifi.com/api-reference/offramp/create-an-offramp.md): An offramp facilitates the conversion of crypto to fiat. Once the crypto transfer is confirmed, HIFI will deposit the converted fiat into the receiving user’s bank account.
- [Cancel an offramp](https://docs.hifi.com/api-reference/offramp/cancel-an-offramp.md): Cancel an offramp that is in review. Only offramps with status `IN_REVIEW` can be cancelled.
- [Accept an offramp quote](https://docs.hifi.com/api-reference/offramp/accept-an-offramp-quote.md): Accept and initiate a quote-based offramp.
- [List all crypto transfers](https://docs.hifi.com/api-reference/crypto-transfer/list-all-crypto-transfers.md): Returns a list of crypto transfers associated with a user under your organization. The crypto transfers are returned sorted by creation date, with the most recent crypto transfers appearing first.
- [Retrieve a crypto transfer](https://docs.hifi.com/api-reference/crypto-transfer/retrieve-a-crypto-transfer.md)
- [List all batch crypto transfers](https://docs.hifi.com/api-reference/crypto-transfer/list-all-batch-crypto-transfers.md): Returns a list of batch crypto transfers associated with a user under your organization. The batch crypto transfers are returned sorted by creation date, with the most recent batch crypto transfers appearing first.
- [Retrieve a batch crypto transfer](https://docs.hifi.com/api-reference/crypto-transfer/retrieve-a-batch-crypto-transfer.md)
- [Create a crypto transfer](https://docs.hifi.com/api-reference/crypto-transfer/create-a-crypto-transfer.md): Create a crypto transfer between two wallet addresses among users.
- [Create a batch crypto transfer](https://docs.hifi.com/api-reference/crypto-transfer/create-a-batch-crypto-transfer.md): Create a batch crypto transfer from a single wallet address to multiple wallet addresses among users.
- [List all offers for a wallet](https://docs.hifi.com/api-reference/canton-offers/list-all-offers-for-a-wallet.md): Retrieve all Canton offers associated with a specific wallet. Offers can be filtered by creation date and limited by count.
- [Retrieve a Canton offer](https://docs.hifi.com/api-reference/canton-offers/retrieve-a-canton-offer.md): Get details of a specific Canton offer by its ID. The offer must belong to the specified wallet.
- [Accept a Canton offer](https://docs.hifi.com/api-reference/canton-offers/accept-a-canton-offer.md): Accept a Canton offer. The offer must be in RECEIVED status and not expired. Upon acceptance, the offer status will change to PENDING and a job will be created to process the acceptance.
- [Reject a Canton offer](https://docs.hifi.com/api-reference/canton-offers/reject-a-canton-offer.md): Reject a Canton offer. The offer must be in RECEIVED status and not expired. Upon rejection, the offer status will change to PENDING and a job will be created to process the rejection.
- [List all bridging requests](https://docs.hifi.com/api-reference/cross-chain-bridge/list-all-bridging-requests.md): Returns a list of bridging requests associated with a user under your organization.
- [Retrieve a bridging request](https://docs.hifi.com/api-reference/cross-chain-bridge/retrieve-a-bridging-request.md)
- [Create a bridging request](https://docs.hifi.com/api-reference/cross-chain-bridge/create-a-bridging-request.md): Create a bridging request to bridge crypto assets across chains.
- [Accept a bridging request](https://docs.hifi.com/api-reference/cross-chain-bridge/accept-a-bridging-request.md): Accept a bridging request to initialize the bridging of crypto assets across chains.
- [List all swaps](https://docs.hifi.com/api-reference/token-swap/list-all-swaps.md): Returns a list of swaps associated with a user under your organization. The swaps are returned sorted by creation date, with the most recent swaps appearing first.
- [Retrieve a swap](https://docs.hifi.com/api-reference/token-swap/retrieve-a-swap.md): Retrieve details of a specific swap by its ID.
- [Create a swap](https://docs.hifi.com/api-reference/token-swap/create-a-swap.md): Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.
- [Accept a swap](https://docs.hifi.com/api-reference/token-swap/accept-a-swap.md): Accept a swap request to execute the cryptocurrency exchange.
- [Request swap cancellation](https://docs.hifi.com/api-reference/token-swap/request-swap-cancellation.md): Request cancellation of a swap while it is still cancellable. A successful response confirms that the cancellation request was recorded; it does not guarantee that the swap has already reached the terminal `CANCELLED` status.
- [Retrieve a swap rate](https://docs.hifi.com/api-reference/token-swap/retrieve-a-swap-rate.md): Get the current market rate for swapping an amount of sourceCurrency into destinationCurrency. Currently only supported between usdc and usdt.
- [List all pending transfer approvals](https://docs.hifi.com/api-reference/transfer-approvals/list-all-pending-transfer-approvals.md): Retrieve all pending transfer approvals that require admin action
- [Get a transfer approval](https://docs.hifi.com/api-reference/transfer-approvals/get-a-transfer-approval.md): Retrieve detailed information about a specific transfer approval
- [Approve a transfer](https://docs.hifi.com/api-reference/transfer-approvals/approve-a-transfer.md): Approve a pending transfer. If enough approvals are received, the transfer will be queued for execution.
- [Reject a transfer](https://docs.hifi.com/api-reference/transfer-approvals/reject-a-transfer.md): Reject a pending transfer. This will cancel the transfer and return funds to the sender.
- [List all settlement rules](https://docs.hifi.com/api-reference/settlement-rules/list-all-settlement-rules.md): List all settlement rules available for virtual accounts.
- [Retrieve a settlement rule](https://docs.hifi.com/api-reference/settlement-rules/retrieve-a-settlement-rule.md): Get an existing settlement rule detail.
- [Create a settlement rule](https://docs.hifi.com/api-reference/settlement-rules/create-a-settlement-rule.md): Create a new settlement rule for virtual accounts. Settlement rules define how fees are calculated and distributed when processing an onramp transaction.
- [Update a settlement rule](https://docs.hifi.com/api-reference/settlement-rules/update-a-settlement-rule.md): Update an existing settlement rule. This will replace all existing rules with the new configuration.
- [Apply settlement rule to virtual account](https://docs.hifi.com/api-reference/settlement-rules/apply-settlement-rule-to-virtual-account.md): Apply a settlement rule to a specific virtual account. This will enable the fee structure defined in the rule for transactions on that account.
- [Delete a settlement rule](https://docs.hifi.com/api-reference/settlement-rules/delete-a-settlement-rule.md): Delete an existing settlement rule.
- [Remove settlement rule from virtual account](https://docs.hifi.com/api-reference/settlement-rules/remove-settlement-rule-from-virtual-account.md): Remove a settlement rule from a specific virtual account. This will disable the fee structure for that account.
- [Get Available Metric Templates](https://docs.hifi.com/api-reference/reporting/get-available-metric-templates.md): Retrieves a list of all available metric templates (e.g., GROSS_VOLUME, TRANSACTION_COUNT). Templates define the logic, supported parameters, and breakdown options available for building reports.
- [Get Template Details](https://docs.hifi.com/api-reference/reporting/get-template-details.md): Returns the specific definition for a template, including its description, the list of fields you can pass as parameters, and the dimensions available for breakdowns.
- [Get Parameter Options](https://docs.hifi.com/api-reference/reporting/get-parameter-options.md): Fetches valid options for specific parameters (e.g., transactionTypes, transactionStatuses) to help validate input or populate UI dropdowns. Supports pagination via query parameters.
- [Create Saved Metric](https://docs.hifi.com/api-reference/reporting/create-saved-metric.md): Creates and saves a new metric configuration to the database. This does not execute the report, but stores the parameters for future use.
- [List Saved Metrics](https://docs.hifi.com/api-reference/reporting/list-saved-metrics.md): Retrieves all saved metric configurations associated with the authenticated profile.
- [Get Metric Details](https://docs.hifi.com/api-reference/reporting/get-metric-details.md): Retrieves the configuration details of a specific saved metric by its UUID.
- [Update Saved Metric](https://docs.hifi.com/api-reference/reporting/update-saved-metric.md): Updates the name, description, or parameters of an existing metric configuration. Supports partial updates.
- [Delete Saved Metric](https://docs.hifi.com/api-reference/reporting/delete-saved-metric.md): Permanently removes a saved metric configuration from the profile.
- [Preview Metric Results](https://docs.hifi.com/api-reference/reporting/preview-metric-results.md): Executes a metric calculation on the fly without saving it to the database. Useful for testing parameters or ad-hoc analysis.
- [Execute Saved Metric](https://docs.hifi.com/api-reference/reporting/execute-saved-metric.md): Runs the calculation for an existing saved metric and returns the dataset.
- [Business Industries](https://docs.hifi.com/references/business-industries/index.md): Below is an overview of the major business industry groups derived from the Business Industry Code List. Each section corresponds to a primary NAICS grouping and links to a detailed page mapping specific industries and codes within that category.

## OpenAPI Specs

- [openapi](https://production.hifi.com/api/v2/openapi.json)
- [openapi](https://production.hifi.com/api/v3/openapi.json)
- [openapi](/openapi.json)