> For the complete documentation index, see [llms.txt](https://docs.ur.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ur.app/api-reference/api.md).

# API

- [Account](https://docs.ur.app/api-reference/api/account.md)
- [Managed Custody Mode](https://docs.ur.app/api-reference/api/account/managed-custody-mode.md)
- [Get BR profile](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-br-profile.md)
- [Get user balance](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-user-balance.md)
- [Get account status](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-account-status.md)
- [Apply for a USD IBAN](https://docs.ur.app/api-reference/api/account/managed-custody-mode/apply-for-a-usd-iban.md)
- [Get off-ramp quote](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-off-ramp-quote.md)
- [Get FX quote](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-fx-quote.md)
- [Execute FX](https://docs.ur.app/api-reference/api/account/managed-custody-mode/execute-fx.md)
- [Get payout fees](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-payout-fees.md)
- [List banks](https://docs.ur.app/api-reference/api/account/managed-custody-mode/list-banks.md)
- [Get bank by IBAN](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-bank-by-iban.md)
- [List countries and cities](https://docs.ur.app/api-reference/api/account/managed-custody-mode/list-countries-and-cities.md)
- [List payment purposes](https://docs.ur.app/api-reference/api/account/managed-custody-mode/list-payment-purposes.md)
- [Verify reference](https://docs.ur.app/api-reference/api/account/managed-custody-mode/verify-reference.md)
- [Verify contact](https://docs.ur.app/api-reference/api/account/managed-custody-mode/verify-contact.md)
- [Submit payout](https://docs.ur.app/api-reference/api/account/managed-custody-mode/submit-payout.md)
- [Get on-ramp limit](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-on-ramp-limit.md)
- [Check pending on-ramp retry](https://docs.ur.app/api-reference/api/account/managed-custody-mode/check-pending-on-ramp-retry.md)
- [Get on-ramp quote](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-on-ramp-quote.md)
- [Get on-ramp liveness token](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-on-ramp-liveness-token.md)
- [Get on-ramp liveness result](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-on-ramp-liveness-result.md)
- [Submit on-ramp](https://docs.ur.app/api-reference/api/account/managed-custody-mode/submit-on-ramp.md)
- [Retry on-ramp swap](https://docs.ur.app/api-reference/api/account/managed-custody-mode/retry-on-ramp-swap.md)
- [Cancel on-ramp retry](https://docs.ur.app/api-reference/api/account/managed-custody-mode/cancel-on-ramp-retry.md)
- [Create card](https://docs.ur.app/api-reference/api/account/managed-custody-mode/create-card.md)
- [Get card info](https://docs.ur.app/api-reference/api/account/managed-custody-mode/get-card-info.md)
- [Set default card currency](https://docs.ur.app/api-reference/api/account/managed-custody-mode/set-default-card-currency.md)
- [Update card status](https://docs.ur.app/api-reference/api/account/managed-custody-mode/update-card-status.md)
- [Fetch transaction history](https://docs.ur.app/api-reference/api/account/managed-custody-mode/fetch-transaction-history.md)
- [External Wallet Access Mode](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode.md)
- [Get server timestamp](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-server-timestamp.md)
- [Check email availability](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/check-email-availability.md)
- [Get user account status](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-user-account-status.md)
- [Mint the user's URID](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/mint-the-users-urid.md)
- [Create a Sumsub SDK token](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/create-a-sumsub-sdk-token.md)
- [Get Form A text](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-form-a-text.md)
- [Submit signed Form A](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/submit-signed-form-a.md)
- [Get user banking profile](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-user-banking-profile.md)
- [Get card info](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-card-info.md)
- [Create card](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/create-card.md)
- [Set default transaction currency](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/set-default-transaction-currency.md)
- [Update card status](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/update-card-status.md)
- [Get transaction history](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-transaction-history.md)
- [Submit token permit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/submit-token-permit.md)
- [Get supported chain config](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-supported-chain-config.md)
- [Get off-ramp quote (EVM)](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-off-ramp-quote-evm.md)
- [Get off-ramp quote (Solana)](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-off-ramp-quote-solana.md)
- [Get on-ramp limit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-on-ramp-limit.md)
- [Get on-ramp quote](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-on-ramp-quote.md)
- [Get liveness token](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-liveness-token.md)
- [Check liveness result](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/check-liveness-result.md)
- [Initiate on-ramp with permit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/initiate-on-ramp-with-permit.md)
- [Check pending on-ramp retry](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/check-pending-on-ramp-retry.md)
- [Retry on-ramp swap with permit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/retry-on-ramp-swap-with-permit.md)
- [Cancel on-ramp retry](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/cancel-on-ramp-retry.md)
- [Verify payment reference](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/verify-payment-reference.md)
- [Verify contact](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/verify-contact.md)
- [Create payout with permit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/create-payout-with-permit.md)
- [Get FX quote](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/get-fx-quote.md)
- [Execute FX with permit](https://docs.ur.app/api-reference/api/account/external-wallet-access-mode/execute-fx-with-permit.md)
- [Delegated Contract Mode](https://docs.ur.app/api-reference/api/account/delegated-contract-mode.md)
- [Exchange authorization code for user info](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/exchange-authorization-code-for-user-info.md)
- [Get supported asset list](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/get-supported-asset-list.md)
- [Get currency exchange rate](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/get-currency-exchange-rate.md)
- [Execute currency exchange](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/execute-currency-exchange.md)
- [Get off-ramp quote](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/get-off-ramp-quote.md)
- [Create off-ramp request](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/create-off-ramp-request.md)
- [Get on-ramp quote](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/get-on-ramp-quote.md)
- [Create on-ramp request](https://docs.ur.app/api-reference/api/account/delegated-contract-mode/create-on-ramp-request.md)
- [Cards](https://docs.ur.app/api-reference/api/cards.md)
- [Get Prefund balance](https://docs.ur.app/api-reference/api/cards/get-prefund-balance.md)
- [Card authorization callback](https://docs.ur.app/api-reference/api/cards/card-authorization-callback.md): UR synchronously calls the partner-hosted authorization endpoint (registered during onboarding) on every card authorization for Card Mode: Crypto Backed users. UR signs the request body with EIP-191 (headers X-Api-Signature and X-Api-PublicKey); the partner must verify the signature against UR's pinned public key before acting, then respond within 500 ms with a signed decision. Timeouts, 5xx responses, signature failures, or invalid responses are treated as DECLINE for the swipe.
- [Card payment transaction webhook](https://docs.ur.app/api-reference/api/cards/card-payment-transaction-webhook.md): UR sends transaction\_v2 when a card payment transaction reaches a terminal state; card payment records use data.type MARQETA\_AUTHORIZE and the same event covers successful and failed payments. UR signs the raw body with EIP-191 (X-Api-Signature); the partner must verify the signer against UR's public key before acting. Return HTTP 200 within 10 seconds; UR retries non-200 or timed-out deliveries up to 3 times at 5-minute intervals, and data.id is the idempotency key.
- [Prefund balance alert webhook](https://docs.ur.app/api-reference/api/cards/prefund-balance-alert-webhook.md): UR emits prefund.balance.alert when the balance of one settlement currency in the Prefund Account crosses its threshold. The alert is per currency and edge-triggered: UR sends it only when the level changes, not repeatedly while the balance sits below the threshold. UR signs the body with EIP-191; the partner must verify the signer against UR's public key, then treat the alert as a trigger (not as truth) and call Get Prefund balance to confirm current state before topping up.
- [KYC And KYB](https://docs.ur.app/api-reference/api/kyc-and-kyb.md)
- [Managed Custody KYC](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc.md)
- [Create the account and onboarding session](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/create-the-account-and-onboarding-session.md)
- [Create a Sumsub access token](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/create-a-sumsub-access-token.md)
- [Get the current onboarding session](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/get-the-current-onboarding-session.md)
- [Hand off a Sumsub share token](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/hand-off-a-sumsub-share-token.md)
- [Check KYC data completeness](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/check-kyc-data-completeness.md)
- [Get Form A text and hash](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/get-form-a-text-and-hash.md)
- [Sign Form A](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/sign-form-a.md)
- [Submit the session for activation](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/submit-the-session-for-activation.md)
- [Receive the KYC onboarding result](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/receive-the-kyc-onboarding-result.md): UR delivers fma.account.result to your registered webhook URL when onboarding reaches a terminal outcome: status activated once the URID reaches Live status and the bank account is open, or status rejected with rejectCode and rejectReason. Verify the EIP-191 signatures, deduplicate on X-Webhook-Request-Id, and acknowledge with HTTP 200; UR retries non-2xx responses with exponential backoff. The payload is identical for Managed Custody Mode and External Wallet Access Mode.
- [Receive the shared-token handoff verdict](https://docs.ur.app/api-reference/api/kyc-and-kyb/managed-custody-kyc/receive-the-shared-token-handoff-verdict.md): Async mirror of a shared-token handoff attempt's verdict, carrying the same conclusion as the synchronous reuse-share-token response and the check endpoints. Sent for passed and incomplete verdicts; terminal verdicts are not webhooked in v1. Partners that only act on remediation may ignore passed events.
- [External Wallet Access KYC](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc.md)
- [Hand off a Sumsub share token for an external wallet user](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc/hand-off-a-sumsub-share-token-for-an-external-wallet-user.md)
- [Check KYC data completeness for an external wallet user](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc/check-kyc-data-completeness-for-an-external-wallet-user.md)
- [Submit KYC for an external wallet user](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc/submit-kyc-for-an-external-wallet-user.md)
- [Create a Sumsub access token by network](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc/create-a-sumsub-access-token-by-network.md)
- [Get Sumsub status by network](https://docs.ur.app/api-reference/api/kyc-and-kyb/external-wallet-access-kyc/get-sumsub-status-by-network.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ur.app/api-reference/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.