# Aurea API Docs

> The **Aurea API** runs wallets and payments for your users under your brand: sign-in, custodial and non-custodial wallets on many chains, sends and swaps, bank and card ramps, payment cards with a EUR account, lending and Earn, [tokenized securities and yield assets](https://docs.aureahub.com/docs/guide-tokenized-assets.md) (on request), and the controls a regulated business needs around them. You integrate it from your server and your apps, over plain JSON and HTTPS.

All pages in one Markdown file: https://docs.aureahub.com/llms-full.txt

## Get Started

- [Overview](https://docs.aureahub.com/docs/introduction.md): The **Aurea API** runs wallets and payments for your users under your brand: sign-in, custodial and non-custodial wallets on many chains, sends and swaps, bank and card ramps, payment cards with a EUR account, lending and Earn, [tokenized securities and yield assets](https://docs.aureahub.com/docs/guide-tokenized-assets.md) (on request), and the controls a regulated business needs around them. You integrate it from your server and your apps, over plain JSON and HTTPS.
- [Environments & Test Data](https://docs.aureahub.com/docs/guide-environments.md): One API for testing and for production: test networks and the products' sandboxes are chosen per request, with the same credentials and the same base URL.
- [Credentials & Rotation](https://docs.aureahub.com/docs/guide-credentials.md): The credentials your integration holds, how your administrators read them, and how to replace each one — on your schedule, or at once when one may have leaked.
- [Authentication](https://docs.aureahub.com/docs/authentication.md): The Aurea API uses two credentials: a **tenant API key and secret**, used to sign requests with HMAC-SHA256, and a **user access token** (JWT), sent as a bearer token.
- [Quickstart](https://docs.aureahub.com/docs/quickstart.md): From your API key to a first confirmed transaction on a test network, in six calls. Node.js 18 or later; every other language works the same way over HTTPS.
- [Feature Availability](https://docs.aureahub.com/docs/feature-availability.md): What every tenant can use today, what Aurea turns on for your tenant when you ask, and what is coming. The other pages mark a feature of the second kind with [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md).

## Concepts

- [Amount Units](https://docs.aureahub.com/docs/amounts.md): How the API expects and returns token and fiat amounts.
- [Pagination](https://docs.aureahub.com/docs/pagination.md): List endpoints don't share a single pagination style — check the table below for the parameters and response shape of each one.
- [Idempotency](https://docs.aureahub.com/docs/idempotency.md): The routes that move funds, and the bank ramp endpoints that create something, take an `Idempotency-Key` header. Everywhere else, know what repeating a call does before you retry it.
- [Errors & Codes](https://docs.aureahub.com/docs/errors.md): Errors come back as JSON with an HTTP status and, on most of them, a stable code to branch on. This page covers the envelope, the statuses, the codes — **1056** of them, **798** answered today and **258** more with stable codes on every error — and how to handle them.
- [Rate Limits](https://docs.aureahub.com/docs/rate-limiting.md): Some sensitive routes are rate-limited per client address. Where your tenant has quotas, every request also counts against a quota per credential and category. There are no plans or tiers.
- [Statuses](https://docs.aureahub.com/docs/enums-states.md): The status values the API returns, and how a resource moves between them.
- [Supported Chains](https://docs.aureahub.com/docs/supported-blockchains.md): Chains are configured per deployment and per tenant. Ask the API which ones your tenant can use instead of relying on a fixed list.
- [Signing Primitives](https://docs.aureahub.com/docs/signing.md): Every cryptographic signature Aurea asks the client to produce, with a copy-pasteable TypeScript example.
- [Versioning](https://docs.aureahub.com/docs/versioning.md): There is one API version, `v1`, and it is part of the path. Aurea never changes an existing answer without notice.
- [Changelog](https://docs.aureahub.com/docs/changelog.md): What changed for tenants, newest first. Every change keeps existing calls answering as before; a feature marked [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md) is turned on for your tenant when you ask.

## Guides: Users & Wallets

- [Users & Sign-In](https://docs.aureahub.com/docs/guide-user-onboarding.md): Take a new user from sign-up to a first wallet, and sign them in and out. Which wallet flow you run is set by your tenant's wallet mode — it is not a per-user choice.
- [Two-Factor Sign-In](https://docs.aureahub.com/docs/guide-two-factor.md): A second factor at sign-in for the accounts that run your tenant: an authenticator app's six-digit code after the password, and ten recovery codes for the day the phone is lost.
- [Passkeys & Step-Up](https://docs.aureahub.com/docs/guide-passkeys.md): A passkey — kept by the user's device or password manager, unlocked with a PIN or a biometric — confirms one sensitive action at a time: an approval's decision, a policy set going live, a change to one's own passkeys. That confirmation is the step-up.
- [Wallets & Custody](https://docs.aureahub.com/docs/guide-non-custodial-keys.md): How a wallet key ends up only on the user's device — by registering a client-side wallet, or by migrating a server-custodial wallet — and what the server keeps at each stage.
- [Accounts](https://docs.aureahub.com/docs/guide-accounts.md): Group a customer's wallets under your own reference for that customer, find the account behind any address of your tenant, and create thousands of accounts at once.
- [Account Structures](https://docs.aureahub.com/docs/guide-account-structures.md): Declare, per network, how your customers' coins are held: segregated — one account per customer, nothing moves by itself — or omnibus, where each customer's collection account is swept to your treasury, withdrawals are paid from a pool of your accounts, and a sub-ledger keeps what each customer is owed.

## Guides: Payments

- [Send & Receive](https://docs.aureahub.com/docs/guide-send-transaction.md): Custodial, non-custodial and gasless sends — one endpoint to start, and at most one more to finish — and how your users receive funds.
- [Operations & Fees](https://docs.aureahub.com/docs/guide-operations.md): One public state machine for everything that moves funds, beside the transactions you already read — and the fee levels, spendable amounts and address checks to prepare a send.
- [Gas Station](https://docs.aureahub.com/docs/guide-gas-station.md): Keep your wallets able to pay their network fees: per chain and asset, a threshold, a target, caps and a maximum gas price, paid from a funding wallet whose key never leaves Aurea's hardware security modules.
- [Token Swaps](https://docs.aureahub.com/docs/guide-swap.md): Every swap starts with a quote. What happens next depends on the source chain, on who holds the wallet key, and on whether the pair qualifies for the gasless flow.
- [Asset & Chain Registry](https://docs.aureahub.com/docs/guide-asset-registry.md): Every asset your tenant uses, on every chain and network, under one key — your own tokens and the catalogue's —, the chains Aurea knows, and custom EVM tokens added by their contract alone, read on chain before anything is stored.
- [Reports](https://docs.aureahub.com/docs/guide-reports.md): Your tenant's movements, balances, addresses and approvals as a CSV or JSON file — made in the background, downloaded through a signed link that works for five minutes.
- [DApps Browser](https://docs.aureahub.com/docs/guide-dapps.md): Back an in-app dApp browser with Aurea: the tenant's dApp catalogue, EIP-191 message signing, nonce and gas lookups, and raw-transaction relay.

## Guides: Ramps, Cards & Yield

- [Bank Ramp: Setup & Customers](https://docs.aureahub.com/docs/guide-bank-customers.md): The bank ramp turns bank transfers into stablecoins and back for your users [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md). This page sets it up for your tenant and makes your users its customers, with their KYC; [Pay-In](https://docs.aureahub.com/docs/guide-fiat-payin.md) and [Payout](https://docs.aureahub.com/docs/guide-fiat-payout.md) move the money.
- [Bank Ramp: Pay-In](https://docs.aureahub.com/docs/guide-fiat-payin.md): Take a user from zero to money in: the bank ramp's KYC, then a virtual IBAN whose bank transfers arrive as stablecoins in a wallet — the user's Aurea wallet, or an address they own.
- [Bank Ramp: Payout](https://docs.aureahub.com/docs/guide-fiat-payout.md): Turn a user's crypto into money on a bank account, paid from the user's own wallet — one of their Aurea wallets, or an address they proved they own. The user's app sends the deposit: Aurea never sends it on its own.
- [Bank Ramp: Local Rails](https://docs.aureahub.com/docs/guide-bank-local.md): The bank ramp's local rails let your users pay in and out in local currencies — through local banks and mobile money — and sell or receive stablecoins against them [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md). This page explains the flows; [Desk Orders](https://docs.aureahub.com/docs/guide-bank-desk.md) covers the desk's currencies.
- [Bank Ramp: Desk Orders](https://docs.aureahub.com/docs/guide-bank-desk.md): The desk trades USDT and USDC against local currencies the instant rails do not cover — such as AOA, BIF, ETB, MZN and MWK — at a quoted rate, in both directions [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md). Orders take hours or days.
- [Card Onramp](https://docs.aureahub.com/docs/guide-card-onramp.md): [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md) Your users pay by card and receive crypto in their wallet. Aurea's card onramp runs the payment page, the KYC, the card payment and the delivery on chain, with a payment provider as merchant of record; you choose where the crypto goes and hear what happened.
- [Cards & EUR Account](https://docs.aureahub.com/docs/guide-cards.md): Give your users a payment card and a personal euro account (an IBAN) on top of their wallet: they sign in to the card program with their wallet, complete onboarding once, and then spend by card, receive euros by bank transfer and pay out to any bank account.
- [Earn](https://docs.aureahub.com/docs/guide-earn.md): Yield products for your users' stablecoins: a deposit from the user's own wallet, a position that grows with a variable rate, and a withdrawal back to the same wallet — through one API, whatever product serves it.
- [Lending](https://docs.aureahub.com/docs/guide-lending.md): Let your users earn a variable rate on their euro stablecoin (EUR.e): supply it to a lending pool from their wallet, watch the position grow, and withdraw it — part or all, interest included — back to the same wallet.

## Guides: Tokenized Assets

- [Tokenized Assets](https://docs.aureahub.com/docs/guide-tokenized-assets.md): Tokenized shares, ETFs and portfolios, and a yield-bearing dollar token, for your users: the catalogue and its market data, each user's eligibility and documents, binding quotes executed on chain, limit orders and corporate actions — through one API, whatever provider issues them.

## Guides: Webhooks & Events

- [Webhooks & Events](https://docs.aureahub.com/docs/guide-events.md): Aurea tells your server what changed — a transaction, a wallet, an account, your policy, an approval, a bank ramp or card onramp record, and more: a signed `POST`, retried until your server takes it, to up to ten endpoints per environment, each with the event types it asks for.

## Security & Governance

- [Server Credentials](https://docs.aureahub.com/docs/guide-server-credentials.md): Sign your server's calls with a key pair your server holds instead of the API secret: register the public key once, then send each request with a short-lived ES256 token.
- [Policy Sets & Groups](https://docs.aureahub.com/docs/guide-policy-sets.md): Write your tenant's signing policy as versions — ordered rules with a verdict each —, check them, try them on your own history, and publish one through a second administrator. On the institutional security profile, the active set decides every signature.
- [Approvals](https://docs.aureahub.com/docs/guide-approvals.md): When your tenant's policy asks for an approval, the money route answers `202` and holds the operation — nothing signed or sent — until the rule's approvers approve it, each with a signature of their own key. Then it goes on as the call would have.
- [Your Tenant's Quorum](https://docs.aureahub.com/docs/guide-tenant-quorum.md): Four eyes on your administrators' sensitive actions: a change to users and roles, credentials and secrets, or custody waits — nothing done — until another administrator of your tenant approves it with their password.
- [Signing Rules](https://docs.aureahub.com/docs/guide-signing-rules.md): What Aurea checks before it signs for your tenant: which messages a wallet may sign, approvals for the exact amount with nothing left over, swaps signed from the route Aurea quoted, and each transaction simulated before it leaves.
- [Address Book](https://docs.aureahub.com/docs/guide-address-book.md): Keep the addresses your tenant's operations may send to: each active only after a cooling period that starts when it is added, an external one proven by its owner if you ask for it. Every tenant's book records the destinations outside it today; where your tenant enforces it [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md), an operation to an address outside the book is refused before anything is signed.
- [Screening & AML Cases](https://docs.aureahub.com/docs/guide-screening.md): Every counterparty checked against the public sanctions lists before your wallets sign, a match held for your compliance team to decide, and the Travel Rule's originator and beneficiary sent with a transfer.
- [Freezes & Quarantines](https://docs.aureahub.com/docs/guide-freezes.md): Stop a user's account or a wallet at once, on every server, and hold one pending operation before it is signed — until someone lifts it.
- [Institution Callback & Co-Signer](https://docs.aureahub.com/docs/guide-institution-callback.md): Two ways to put your own infrastructure in the signing path. The **institution callback** [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md): before one of your tenant's keys signs, Aurea asks your own endpoint, and signs only if it approves — the question and the answer both signed. **Your own MPC co-signer** (at the end of this page): the share Aurea would hold of your MPC wallets is held by your co-signer instead.
- [Security & Data Residency](https://docs.aureahub.com/docs/guide-data-residency.md): Aurea runs in an EU region in Italy. Every copy of your data that Aurea keeps stays in the European Union.

## Agentic Payments

- [Overview & SDK](https://docs.aureahub.com/docs/agentic-payments.md): AI agents that transact within policy. Two products on one API: a shopper-facing commerce **widget** (Product A) you embed in a store, and an in-account **treasury agent** (Product B) that pays a merchant's own suppliers and payouts on instruction — every payment bounded by a spend policy and an approval threshold.
- [API Reference](https://docs.aureahub.com/docs/agentic-api.md): All 52 endpoints under `https://api.aureahub.com/v1/agent-payments` you can call. Unless noted, every route requires a tenant-admin JWT. The shopper-facing commerce routes also accept a scoped merchant API key; the only unauthenticated route is the payment provider's own callback, which you never call.

## API Reference: Health

- [Health Check](https://docs.aureahub.com/docs/health-check.md): GET /health. Lightweight liveness probe for the Aurea API — use to verify the service is reachable before starting a flow.

## API Reference: Auth

- [Register](https://docs.aureahub.com/docs/auth-register.md): POST /v1/auth/register. Create a user with username, email and password, and receive an access token, a refresh token and the user profile in the same response. A wallet can be created or imported in the same call.
- [Login](https://docs.aureahub.com/docs/auth-login.md): POST /v1/auth/login. Sign in an existing user with username and password and receive an access token, a refresh token and the user profile.
- [Refresh Token](https://docs.aureahub.com/docs/auth-refresh.md): POST /v1/auth/refresh. Exchange a refresh token for a new access token without asking the user to sign in again.
- [Google Sign-In](https://docs.aureahub.com/docs/auth-google.md): POST /v1/auth/google. Exchange a Google ID token for Aurea tokens. The matching user is signed in, or a new user is created on first use.
- [Apple Sign-In](https://docs.aureahub.com/docs/auth-apple.md): POST /v1/auth/apple. Exchange a Sign in with Apple identity token for Aurea tokens. The linked user is signed in, or a new user is created on first use.
- [Forgot Password](https://docs.aureahub.com/docs/auth-forgot-password.md): POST /v1/auth/forgot-password. Native, email-based password reset. A user requests a link, opens it, and sets a new password — with single-use tokens, anti-enumeration, and invalidation of earlier refresh tokens.
- [Log Out](https://docs.aureahub.com/docs/auth-logout.md): POST /v1/auth/logout. End a session on the server: the refresh token you send is revoked, and it can no longer be exchanged for an access token.
- [Your Sessions](https://docs.aureahub.com/docs/auth-sessions.md): GET /v1/auth/sessions. Where the signed-in user is signed in: one entry per active session, the most recently active first. Every role may read its own.
- [End a Session](https://docs.aureahub.com/docs/auth-session-end.md): DELETE /v1/auth/sessions/{sessionId}. End one of the signed-in user's own sessions — a lost phone, a shared computer. Every role may end its own.
- [Sign Out Elsewhere](https://docs.aureahub.com/docs/auth-sessions-revoke-others.md): POST /v1/auth/sessions/revoke-others. End every session of the signed-in user except the one making the request. Every role may end its own.

## API Reference: Two-Factor Sign-In

- [Your Second Factor](https://docs.aureahub.com/docs/mfa-status.md): GET /v1/auth/mfa. Whether your account is asked a second factor at sign-in, and what it has enrolled.
- [Enrol an App](https://docs.aureahub.com/docs/mfa-totp-start.md): POST /v1/auth/mfa/totp. A new secret for an authenticator app, shown once. It becomes your second factor once its first code is confirmed.
- [Confirm the App](https://docs.aureahub.com/docs/mfa-totp-confirm.md): POST /v1/auth/mfa/totp/confirm. The enrolment's first code: the app becomes your second factor, and your ten recovery codes are shown — once.
- [New Recovery Codes](https://docs.aureahub.com/docs/mfa-recovery-codes.md): POST /v1/auth/mfa/recovery-codes. Ten new recovery codes; the old ones stop working.
- [Remove the App](https://docs.aureahub.com/docs/mfa-totp-remove.md): DELETE /v1/auth/mfa/totp. Your second factor and its recovery codes go; the next sign-in asks only the password.
- [Sign In: Second Step](https://docs.aureahub.com/docs/mfa-verify.md): POST /v1/auth/mfa/verify. After the password, the code: the answer is the login's, with the tokens.
- [Reset a User's Factor](https://docs.aureahub.com/docs/mfa-reset.md): DELETE /v1/admin/tenants/{tenantId}/users/{userId}/mfa. A user lost their phone and their recovery codes: an administrator removes their authenticator app, and they enrol a new one.

## API Reference: Passkeys

- [List Your Passkeys](https://docs.aureahub.com/docs/passkeys-list.md): GET /v1/auth/passkeys. Your passkeys, newest first — revoked ones included —, and your tenant's step-up mode.
- [Registration Options](https://docs.aureahub.com/docs/passkey-registration-options.md): POST /v1/auth/passkeys/registration/options. Start registering a passkey: the options the browser makes it with.
- [Register a Passkey](https://docs.aureahub.com/docs/passkey-register.md): POST /v1/auth/passkeys. The browser's answer to the registration's options: verified, and registered as one of your passkeys.
- [Revoke a Passkey](https://docs.aureahub.com/docs/passkey-revoke.md): POST /v1/auth/passkeys/{passkeyId}/revoke. One of your passkeys, revoked for good: it confirms nothing from now on.
- [Step-Up Options](https://docs.aureahub.com/docs/step-up-options.md): POST /v1/auth/step-up/options. Start a step-up for one action on one target: the options one of your passkeys answers.
- [Step-Up](https://docs.aureahub.com/docs/step-up.md): POST /v1/auth/step-up. Your passkey's answer to the step-up's options: a token for that one action, for two minutes.
- [Your Passkey Address](https://docs.aureahub.com/docs/passkey-address.md): GET /v1/admin/tenants/{id}/passkey-address. The relying party id and the web addresses your own apps use for passkeys and the step-up, beside Aurea's own [Coming soon, upon request](https://docs.aureahub.com/docs/feature-availability.md).
- [Reset a User's Passkeys](https://docs.aureahub.com/docs/passkeys-reset.md): DELETE /v1/admin/tenants/{tenantId}/users/{userId}/passkeys. A user lost the device that held their passkeys: an administrator revokes them all, and the user registers a new one.

## API Reference: Your Tenant

- [Get Your Tenant](https://docs.aureahub.com/docs/tenant-info.md): GET /v1/tenant. The tenant of the signed-in user: its id, name, status, logo and settings. Every role may read it.
- [Get Public Config](https://docs.aureahub.com/docs/tenant-public.md): GET /v1/tenant/public. Your tenant's branding and sign-in options, readable before anyone signs in: call it when your app starts.
- [Available Features](https://docs.aureahub.com/docs/tenant-features.md): GET /v1/tenant/available-features. Three switches of the signed-in user's tenant, for showing or hiding parts of your app.
- [Enabled EVM Chains](https://docs.aureahub.com/docs/tenant-blockchain.md): GET /v1/tenant/blockchain-configs. The EVM networks enabled for the signed-in user's tenant, with their chain ids and explorers. Every role may read it.
- [Your Tenant's Insights](https://docs.aureahub.com/docs/tenant-insights.md): GET /v1/admin/tenants/{id}/insights. Your tenant's users, wallets, operations and volume over the last 24 hours, 7 days and 30 days, each beside the period before. For the roles that read the tenant's transactions.
- [Search Your Tenant](https://docs.aureahub.com/docs/tenant-search.md): GET /v1/admin/tenants/{id}/search. Find your tenant's users, wallets and operations from one text: an id, a wallet address, a transaction hash, an email, or the start of a username or email. Every role but the end user may search; each kind of record only for a role that reads it.

## API Reference: Credentials

- [Get the API Key](https://docs.aureahub.com/docs/admin-tenants-apikey.md): GET /v1/admin/tenants/{id}/api-key. Your tenant's API key in full, the value your server sends as `x-tenant-api-key`. For the Owner, Admin, Non-signing Admin and Security Admin roles.
- [Rotate the API Key](https://docs.aureahub.com/docs/admin-tenants-rotatekey.md): POST /v1/admin/tenants/{id}/rotate-key. Replace your tenant's API key. **The old key stops working at once**: every signed request still sending it is refused. For the Owner, Admin, Non-signing Admin and Security Admin roles.
- [Get the API Secret](https://docs.aureahub.com/docs/admin-tenants-secret.md): GET /v1/admin/tenants/{id}/api-secret. Your tenant's API secret, the key of the HMAC signature. For the Owner, Admin, Non-signing Admin and Security Admin roles.
- [Rotate the API Secret](https://docs.aureahub.com/docs/admin-tenants-rotatesecret.md): POST /v1/admin/tenants/{id}/rotate-secret. Replace your tenant's API secret. **The old secret stops working at once**: every request it signs is refused (`401` `Invalid signature`). For the Owner, Admin, Non-signing Admin and Security Admin roles.
- [List Credentials](https://docs.aureahub.com/docs/server-credentials-list.md): GET /v1/admin/tenants/{id}/server-credentials. Your tenant's server credentials, newest first — active, expired and revoked.
- [Register a Credential](https://docs.aureahub.com/docs/server-credential-create.md): POST /v1/admin/tenants/{id}/server-credentials. Register the public key of a key pair your server holds. Its tokens are accepted from the moment this answers.
- [Change a Credential](https://docs.aureahub.com/docs/server-credential-update.md): PATCH /v1/admin/tenants/{id}/server-credentials/{credentialId}. Its name, role, allow-list or expiry. The key never changes: a new key is a new credential.
- [Revoke a Credential](https://docs.aureahub.com/docs/server-credential-revoke.md): POST /v1/admin/tenants/{id}/server-credentials/{credentialId}/revoke. For good, and at once: its next token is refused, the credential never changes again, and your endpoints that ask for it are told.

## API Reference: Users

- [Get My Profile](https://docs.aureahub.com/docs/users-me.md): GET /v1/users/{id}. Read the signed-in user's own profile.
- [Update My Profile](https://docs.aureahub.com/docs/users-me-update.md): PATCH /v1/users/me. Update the authenticated user's username and/or display name.
- [List Users](https://docs.aureahub.com/docs/users-list.md): GET /v1/users/. Retrieve a paginated list of all users in the tenant. Primarily used in admin and back-office dashboards.
- [Create User](https://docs.aureahub.com/docs/users-create.md): POST /v1/users/. Programmatically create a new user from your server — distinct from the self-registration flow.
- [Get User](https://docs.aureahub.com/docs/users-get.md): GET /v1/users/{id}. Retrieve the full profile of a specific user by their UUID.
- [Update User](https://docs.aureahub.com/docs/users-update.md): PUT /v1/users/{id}. Change a user's email address or password. At least one of the two.
- [Delete User](https://docs.aureahub.com/docs/users-delete.md): DELETE /v1/users/{id}. Deactivate a user account. This is a soft-delete — data is retained but the user can no longer authenticate.
- [Search Users](https://docs.aureahub.com/docs/users-search.md): GET /v1/users/search. Find users by username — the primary lookup for peer-to-peer payment flows.
- [Advanced Search](https://docs.aureahub.com/docs/users-advsearch.md): GET /v1/users/advanced-search. Look up users by wallet address, wallet UUID, or username — built for admin tools and dispute resolution flows.
- [Update fcm-token](https://docs.aureahub.com/docs/users-fcm.md): PATCH /v1/users/me/fcm-token. `PATCH /v1/users/me/fcm-token`, a second route that registers the signed-in user's device push token. To register a device, use [Register Device](https://docs.aureahub.com/docs/notif-register.md) (`POST /v1/notifications/device-token`); this route stays for the apps that already call it, under its contract name.
- [Generate QR Code](https://docs.aureahub.com/docs/users-qr.md): GET /v1/users/{id}/qr-code. Get a payment QR code for a user — encodes a deep link that pre-fills a send form with the recipient's username and tenant.
- [List User Wallets](https://docs.aureahub.com/docs/users-wallets.md): GET /v1/users/{id}/wallets. Retrieve all wallets owned by a specific user, across all supported blockchains.

## API Reference: Wallets

- [Create Wallet](https://docs.aureahub.com/docs/wallets-create.md): POST /v1/wallets/. Generate a new blockchain wallet for the authenticated user — either custodial (key managed by Aurea) or non-custodial (user-controlled key). Wallets are cross-chain and any network or token can be supported upon request.
- [List Wallets](https://docs.aureahub.com/docs/wallets-list.md): GET /v1/wallets/. Retrieve all wallets owned by the authenticated user, with optional chain filtering.
- [List Your Tenant's Wallets](https://docs.aureahub.com/docs/tenant-wallets-list.md): GET /v1/admin/tenants/{id}/wallets. Every wallet of your tenant, whoever owns it, newest first: address, network, owner, who holds the key, status and the balances last read. For the roles that read the tenant's transactions.
- [Import Wallet](https://docs.aureahub.com/docs/wallets-import.md): POST /v1/wallets/import. Bring an existing self-custodied wallet into Aurea's managed system using a private key or mnemonic phrase.
- [Get Wallet](https://docs.aureahub.com/docs/wallets-get.md): GET /v1/wallets/{id}. Retrieve the details of a specific wallet by its UUID.
- [Delete Wallet](https://docs.aureahub.com/docs/wallets-delete.md): DELETE /v1/wallets/{id}. Remove a wallet from the user's account. The primary wallet cannot be deleted.
- [Get Balance](https://docs.aureahub.com/docs/wallets-balance.md): GET /v1/wallets/{id}/balance. Retrieve the native coin and all token balances for a specific wallet, with optional testnet support.
- [Aggregate Balances](https://docs.aureahub.com/docs/wallets-aggregate.md): GET /v1/wallets/balances/aggregate. Get a consolidated portfolio view — total value across all wallets and chains, broken down by asset and chain.
- [Set Primary Wallet](https://docs.aureahub.com/docs/wallets-primary.md): PATCH /v1/wallets/{id}/primary. Mark a wallet as the user's primary wallet for its chain and network type (mainnet or testnet).
- [Non-Custodial Challenge](https://docs.aureahub.com/docs/wallets-client-challenge.md): GET /v1/wallets/client/challenge. Get a one-time challenge that proves the user controls the private key of a wallet generated on their device — step 1 of registering a client-side (non-custodial) wallet.
- [Register Client Wallet](https://docs.aureahub.com/docs/wallets-client-register.md): POST /v1/wallets/client. Create a non-custodial wallet whose private key stays on the user's device. Aurea verifies the signed challenge and stores only the address.
- [Confirm Client Custody](https://docs.aureahub.com/docs/wallets-confirm-custody.md): POST /v1/wallets/confirm-client-custody. Final step of migrating a server-custodial wallet to client-side custody: prove the device holds the exported key, and the server removes its own copy.
- [Register Device Key](https://docs.aureahub.com/docs/wallets-register-device.md): POST /v1/wallets/register-device. Attach a device public key to a wallet, authorised by a signature from the wallet's own private key.
- [Request Export Token](https://docs.aureahub.com/docs/wallets-export-token.md): POST /v1/wallets/request-export-token. Start migrating a server-custodial wallet to client-side custody: re-confirm the user's password and receive a one-time export token.
- [Export Encrypted Key](https://docs.aureahub.com/docs/wallets-export-key.md): POST /v1/wallets/export-key. Step 2 of key migration: receive the wallet's private key encrypted to an ephemeral X25519 key generated on the device.
- [Migration Challenge](https://docs.aureahub.com/docs/wallets-migration-challenge.md): GET /v1/wallets/migration-challenge. Get a one-time challenge to sign with an existing wallet's private key — consumed by Confirm Client Custody or Register Device Key.
- [Cancel Migration](https://docs.aureahub.com/docs/wallets-cancel-migration.md): POST /v1/wallets/cancel-migration. Abort a key migration before the key has been exported, returning the wallet to server custody.
- [Set Primary (atomic)](https://docs.aureahub.com/docs/wallets-set-primary.md): PATCH /v1/wallets/{id}/set-primary. Promote a wallet to primary and demote the user's other primary wallets on the same network type in a single database transaction. No request body.

## API Reference: Accounts

- [List Accounts](https://docs.aureahub.com/docs/accounts-list.md): GET /v1/accounts. Your tenant's accounts, newest first: those you created, and each user's default account while it holds a wallet or once it was written to.
- [Create an Account](https://docs.aureahub.com/docs/account-create.md): POST /v1/accounts. An account of your tenant, with your reference for the customer, a name, tags and its users. It holds no wallet yet.
- [Get an Account](https://docs.aureahub.com/docs/account-get.md): GET /v1/accounts/{accountId}. One account with its users and wallets. A user's id reads that user's default account.
- [Change an Account](https://docs.aureahub.com/docs/account-update.md): PATCH /v1/accounts/{accountId}. Its name, tags, visibility and users, and its `customerRefId` once.
- [Add a Wallet](https://docs.aureahub.com/docs/account-wallet-add.md): POST /v1/accounts/{accountId}/wallets. Have Aurea make the account's wallet on a chain, or put one of its owner's wallets in it.
- [Find by Address](https://docs.aureahub.com/docs/account-lookup.md): GET /v1/accounts/lookup. The reverse lookup: the account — and your reference for its customer — of each of your tenant's wallets at an address.
- [Create in Bulk](https://docs.aureahub.com/docs/accounts-bulk-create.md): POST /v1/accounts/bulk. Up to 10,000 accounts in one request, each with your reference for its customer, and optionally a wallet on each chain you list.
- [List Bulk Creations](https://docs.aureahub.com/docs/accounts-bulk-list.md): GET /v1/accounts/bulk. Your tenant's bulk creations of accounts, newest first, with their counts.
- [Bulk Creation Report](https://docs.aureahub.com/docs/accounts-bulk-get.md): GET /v1/accounts/bulk/{jobId}. A bulk creation, its counts, and each of its accounts in the order of the request.

## API Reference: Account Structures

- [List Structures](https://docs.aureahub.com/docs/structures-list.md): GET /v1/structures. Your tenant's structure on each network: `mainnet`, then `testnet`.
- [Get a Structure](https://docs.aureahub.com/docs/structures-get.md): GET /v1/structures/{network}. Your tenant's structure on one network, with its treasury, its pool, how many collection accounts it has and its sweep policies.
- [Declare a Structure](https://docs.aureahub.com/docs/structures-put.md): PUT /v1/structures/{network}. Make a network omnibus — with its treasury, its pool, the pool's rule and your funding addresses — or bring it back to segregated.
- [List Collection Accounts](https://docs.aureahub.com/docs/structures-collection-list.md): GET /v1/structures/{network}/collection-accounts. The omnibus's collection accounts on a network — one per customer —, by account id.
- [Add Collection Accounts](https://docs.aureahub.com/docs/structures-collection-add.md): POST /v1/structures/{network}/collection-accounts. Make up to 1,000 of your accounts collection accounts of the omnibus: one per customer.
- [Remove a Collection Account](https://docs.aureahub.com/docs/structures-collection-remove.md): DELETE /v1/structures/{network}/collection-accounts/{accountId}. Take a customer's account out of the omnibus, once the omnibus owes them nothing.
- [List Sweep Policies](https://docs.aureahub.com/docs/structures-policies-list.md): GET /v1/structures/{network}/sweep-policies. A network's sweep policies, per chain and asset: what a sweep moves, what it leaves behind, how often and when.
- [Set a Sweep Policy](https://docs.aureahub.com/docs/structures-policy-put.md): PUT /v1/structures/{network}/sweep-policies/{chainId}/{asset}. For one asset on one EVM chain of the network: the least a sweep moves, what it leaves behind, how often and in which UTC window.
- [Remove a Sweep Policy](https://docs.aureahub.com/docs/structures-policy-delete.md): DELETE /v1/structures/{network}/sweep-policies/{chainId}/{asset}. Stop treating an asset of a chain as an omnibus asset, once no customer holds a claim on it.
- [Read the Sub-Ledger](https://docs.aureahub.com/docs/structures-ledger.md): GET /v1/structures/{network}/ledger. What the omnibus owes each customer, per chain and asset, and your tenant's own position in it: the house.
- [List Sub-Ledger Entries](https://docs.aureahub.com/docs/structures-ledger-entries.md): GET /v1/structures/{network}/ledger/entries. Every movement of the omnibus's sub-ledger, newest first: openings, deposits, withdrawals, their reversals, the house's deposits, the fees and Aurea's adjustments.
- [Read the Reconciliation](https://docs.aureahub.com/docs/structures-reconciliation.md): GET /v1/structures/{network}/reconciliation. Per omnibus asset, the last comparison of what the omnibus's wallets hold on chain with what it owes your customers plus the house.
- [List Transfers](https://docs.aureahub.com/docs/structures-transfers-list.md): GET /v1/structures/{network}/transfers. The omnibus's sweeps and pool withdrawals on a network, newest first.
- [Get a Transfer](https://docs.aureahub.com/docs/structures-transfer-get.md): GET /v1/structures/{network}/transfers/{transferId}. One sweep or pool withdrawal, as it is now.
- [Request a Pool Withdrawal](https://docs.aureahub.com/docs/structures-withdrawal-create.md): POST /v1/structures/{network}/withdrawals. Pay a customer out of the omnibus: the amount leaves their claim at once, and Aurea sends it from your pool.

## API Reference: MPC Wallets

- [MPC Config](https://docs.aureahub.com/docs/mpc-config.md): GET /v1/mpc/config. Discover whether MPC (threshold-signature) wallets are enabled for the tenant and whether the current user already has an MPC wallet provisioned.
- [Start DKG Ceremony](https://docs.aureahub.com/docs/mpc-dkg-start.md): POST /v1/mpc/wallets/dkg/start. Begin a 2-of-3 distributed key generation ceremony — the first step in provisioning a new MPC wallet.
- [Register MPC Wallet](https://docs.aureahub.com/docs/mpc-wallet-register.md): POST /v1/mpc/wallets. Finalise a completed DKG ceremony — Aurea verifies the address against the relay record and persists the wallet.
- [Start Aux Ceremony](https://docs.aureahub.com/docs/mpc-aux-start.md): POST /v1/mpc/wallets/{walletId}/aux/start. A CGGMP wallet's second ceremony, run once after the DKG and before the first signature.
- [Start Signing Ceremony](https://docs.aureahub.com/docs/mpc-sign-start.md): POST /v1/mpc/wallets/{walletId}/sign/start. Open a threshold-signing session against an MPC wallet — for either the normal DEVICE+AUREA flow or BACKUP-based recovery.
- [Start a Backup Proof](https://docs.aureahub.com/docs/mpc-backup-proof-start.md): POST /v1/mpc/wallets/{walletId}/backup-proof/start. Prove that the user still holds an MPC wallet's backup share: the backup share and Aurea's cosigner sign a challenge of Aurea's together, and Aurea records when.
- [Complete a Backup Proof](https://docs.aureahub.com/docs/mpc-backup-proof-complete.md): POST /v1/mpc/wallets/{walletId}/backup-proof/complete. Send the signature the backup proof's ceremony produced: Aurea records that the wallet's backup share is held.
- [Get the Backup State](https://docs.aureahub.com/docs/mpc-backup-get.md): GET /v1/mpc/wallets/{walletId}/backup. Whether an MPC wallet's backup share was proven held, when, and whether to ask the user to prove it again.
- [Service Token Bridge](https://docs.aureahub.com/docs/mpc-service-token.md): POST /v1/mpc/service/token. Exchange a first-party app session for a short-lived Hub JWT scoped to a single merchant — required to drive MPC ceremonies from a downstream product (e.g. aurea-pay).
- [Relay: Join Session](https://docs.aureahub.com/docs/mpc-relay-join.md): POST /v1/mpc/relay/session/{id}/join. Announce a party (DEVICE / BACKUP / AUREA) into an MPC ceremony session.
- [Relay: List Parties](https://docs.aureahub.com/docs/mpc-relay-parties.md): GET /v1/mpc/relay/session/{id}/parties. Poll the roster of parties that have joined an MPC ceremony — used to wait for the AUREA cosigner before starting the message loop.
- [Relay: Post Message](https://docs.aureahub.com/docs/mpc-relay-msg.md): POST /v1/mpc/relay/session/{id}/msg. Forward a ceremony envelope to another party (or broadcast to all).
- [Relay: Read Inbox](https://docs.aureahub.com/docs/mpc-relay-inbox.md): GET /v1/mpc/relay/session/{id}/inbox. Drain inbound ceremony envelopes for a given party.
- [Relay: Get Message Hash](https://docs.aureahub.com/docs/mpc-relay-msghash.md): GET /v1/mpc/relay/session/{id}/msghash. Fetch the message-hash that the signing ceremony was opened against — used by a joining party to verify it is signing what it expects.
- [Relay: Post Result](https://docs.aureahub.com/docs/mpc-relay-result.md): POST /v1/mpc/relay/session/{id}/result. Publish a party's final ceremony output (e.g. its signature share, or a "done" marker) into the session.
- [Relay: Read Results](https://docs.aureahub.com/docs/mpc-relay-results.md): GET /v1/mpc/relay/session/{id}/results. Read the final outputs posted by each party — the last step in any MPC ceremony.
- [Register a Recovery Key](https://docs.aureahub.com/docs/mpc-recovery-key-register.md): PUT /v1/tenant/mpc-recovery-key. Register your tenant's recovery public key: the key Aurea seals its share of your MPC wallets to, so you can check — and if need be rebuild — a wallet's key without Aurea.
- [Get the Recovery Key](https://docs.aureahub.com/docs/mpc-recovery-key-get.md): GET /v1/tenant/mpc-recovery-key. Read which recovery key your tenant has registered, and when.

## API Reference: MPC Co-Signer

- [Get the Co-Signer Settings](https://docs.aureahub.com/docs/mpc-cosigner-get.md): GET /v1/admin/tenants/{id}/mpc-cosigner. Your tenant's own MPC co-signer, if it has one, and whether tenant co-signers are available.
- [Change the Co-Signer Settings](https://docs.aureahub.com/docs/mpc-cosigner-put.md): PUT /v1/admin/tenants/{id}/mpc-cosigner. Save your tenant's own MPC co-signer: its mode, its nodes, the CA they are pinned to and the server credential it presents. The HMAC secret is shown when it is made, and never again.

## API Reference: Transactions

- [Create Transaction](https://docs.aureahub.com/docs/tx-create.md): POST /v1/transactions/. Send a native coin or a token from a wallet the authenticated user owns.
- [Broadcast Transaction](https://docs.aureahub.com/docs/tx-broadcast.md): POST /v1/transactions/{id}/broadcast. Submit the client's signature for a non-custodial send so Aurea can put it on-chain.
- [List Transactions](https://docs.aureahub.com/docs/tx-list.md): GET /v1/transactions/. Page through the authenticated user's blockchain transaction records, newest first.
- [Get Transaction](https://docs.aureahub.com/docs/tx-get.md): GET /v1/transactions/{id}. Fetch one of the authenticated user's transaction records by ID.
- [Get Tx Status](https://docs.aureahub.com/docs/tx-status.md): GET /v1/transactions/{id}/status. Check a transaction against the chain and get its current status and confirmation count.
- [Transaction Quote](https://docs.aureahub.com/docs/tx-quote.md): POST /v1/transactions/quote. Estimate the network fee of a send, in the native coin and in EUR, before creating it.
- [Get Aggregated Tx](https://docs.aureahub.com/docs/tx-aggregated-get.md): GET /v1/transactions/aggregated/{id}. Fetch a single item of the Unified Transaction Feed by its ID.
- [Travel Rule Data](https://docs.aureahub.com/docs/tx-travel-rule.md): GET /v1/transactions/{id}/travel-rule. The originator, beneficiary and VASPs a transfer was sent with, in IVMS101, as Aurea stored them.

## API Reference: Operations

- [List Operations](https://docs.aureahub.com/docs/operations-list.md): GET /v1/operations. The operations the money routes started, newest first, with their public state.
- [Count Operations](https://docs.aureahub.com/docs/operations-count.md): GET /v1/operations/count. How many operations match a set of filters, and how many of them were created in the last 24 hours — without paging through [List Operations](https://docs.aureahub.com/docs/operations-list.md).
- [Get an Operation](https://docs.aureahub.com/docs/operation-get.md): GET /v1/operations/{id}. One operation, with every state it passed, and what its signing points decoded, simulated and checked.
- [Get by Your Own Id](https://docs.aureahub.com/docs/operation-by-external-id.md): GET /v1/operations/by-external-id/{externalTxId}. The operation your tenant named with its own id, `externalTxId`, with every state it passed.
- [Get Its Approval](https://docs.aureahub.com/docs/operation-approval.md): GET /v1/operations/{id}/approval. For the operations a policy held: the approval request, its decisions, and — once approved and gone on — the answer the call would have given.
- [Get Its Callback](https://docs.aureahub.com/docs/operation-callback.md): GET /v1/operations/{id}/callback. For the operations your institution callback held: the request it was held on, and — once your endpoint approved and the operation went on — the answer the call would have given.
- [Cancel](https://docs.aureahub.com/docs/operation-cancel.md): POST /v1/operations/{id}/cancel. Cancel one of your own operations while nothing of it was sent: what it prepared can no longer be broadcast.
- [Get a Signing Check](https://docs.aureahub.com/docs/operation-signing-check.md): GET /v1/operations/signing-checks/{checkId}. What the message rules, the exact approvals or the server's build of a swap said at one signing point — the check a refusal names in `details.checkId`.

## API Reference: Gas Station

- [Gas Station Settings](https://docs.aureahub.com/docs/gas-station-settings.md): GET /v1/gas-station/settings. Your tenant's gas mode, and whether the Gas Station runs.
- [List Policies](https://docs.aureahub.com/docs/gas-station-policies.md): GET /v1/gas-station/policies. Your tenant's policies, and Aurea's default policies, which apply where you have none for a chain and asset.
- [Create a Policy](https://docs.aureahub.com/docs/gas-station-policy-create.md): POST /v1/gas-station/policies. For one chain and asset: when a covered wallet is topped up, up to what, how much at most, and never above which gas price.
- [Change a Policy](https://docs.aureahub.com/docs/gas-station-policy-update.md): PATCH /v1/gas-station/policies/{policyId}. Its limits, coverage or switch. Its chain and asset never change.
- [List Funding Wallets](https://docs.aureahub.com/docs/gas-station-funding-wallets.md): GET /v1/gas-station/funding-wallets. Your tenant's funding wallets — one per chain and network —, each with its native balance read now.
- [Create a Funding Wallet](https://docs.aureahub.com/docs/gas-station-funding-wallet-create.md): POST /v1/gas-station/funding-wallets. The wallet that pays your policies' top-ups on one chain. Its key is made in Aurea's hardware security modules and never exported.
- [List Top-Ups](https://docs.aureahub.com/docs/gas-station-top-ups.md): GET /v1/gas-station/top-ups. Your tenant's top-ups and skips, newest first.
- [List Alarms](https://docs.aureahub.com/docs/gas-station-alarms.md): GET /v1/gas-station/alarms. The Gas Station's open alarms about your funding wallets, your policies and your wallets' top-ups.

## API Reference: Fees & Addresses

- [Estimate Fees](https://docs.aureahub.com/docs/fees-estimate.md): GET /v1/fees/estimate. LOW, MEDIUM and HIGH fee levels for one of your tenant's chains, from its recent fees.
- [Most a Wallet Can Send](https://docs.aureahub.com/docs/wallet-max-spendable.md): GET /v1/wallets/{id}/max-spendable. For one of your own wallets: how much of an asset it can send at a fee level.
- [Validate an Address](https://docs.aureahub.com/docs/address-validate.md): POST /v1/addresses/validate. Whether an address is well formed for a chain, its checksum, and what sits there.

## API Reference: Tokens

- [List Tokens](https://docs.aureahub.com/docs/tokens-list.md): GET /v1/tokens/. List the tokens configured for your tenant, grouped by chain.
- [Tokens by Chain](https://docs.aureahub.com/docs/tokens-by-chain.md): GET /v1/tokens/chain/{chain}. Retrieve all tokens available on a specific blockchain — ideal for populating swap and send forms after a chain is selected.
- [Supported Chains](https://docs.aureahub.com/docs/tokens-chains.md): GET /v1/tokens/meta/chains. Retrieve the authoritative runtime list of chain identifiers enabled for your tenant. More networks and tokens can be added for your tenant on request.
- [List Your Tokens](https://docs.aureahub.com/docs/admin-tokens-list.md): GET /v1/admin/tenants/{tenantId}/tokens. Your tenant's token list: the tokens your users' wallets show and send, by chain and network. Read by the `owner`, `tenantadmin`, `non_signing_admin`, `signer`, `approver`, `editor`, `viewer` and `auditor` roles, on their own tenant. Registering an asset of the [Asset & Chain Registry](https://docs.aureahub.com/docs/guide-asset-registry.md) adds its token here too.
- [Add a Token](https://docs.aureahub.com/docs/admin-tokens-create.md): POST /v1/admin/tenants/{tenantId}/tokens. Add a custom token to your tenant's token list. For the `owner`, `tenantadmin`, `non_signing_admin` and `editor` roles, on their own tenant.
- [Change a Token](https://docs.aureahub.com/docs/admin-tokens-update.md): PATCH /v1/admin/tenants/{tenantId}/tokens/{tokenId}. Change a token of your tenant's list. For the `owner`, `tenantadmin`, `non_signing_admin` and `editor` roles, on their own tenant.
- [Switch a Token On or Off](https://docs.aureahub.com/docs/admin-tokens-toggle.md): PATCH /v1/admin/tenants/{tenantId}/tokens/{tokenId}/active. Switch a token of your list on or off without removing it. For the `owner`, `tenantadmin`, `non_signing_admin` and `editor` roles, on their own tenant.
- [Remove a Token](https://docs.aureahub.com/docs/admin-tokens-delete.md): DELETE /v1/admin/tenants/{tenantId}/tokens/{tokenId}. Remove a token from your tenant's list. For the `owner`, `tenantadmin`, `non_signing_admin` and `editor` roles, on their own tenant.

## API Reference: Asset Registry

- [List Assets](https://docs.aureahub.com/docs/assets-list.md): GET /v1/assets. Your tenant's assets on every chain and network — its own, and the catalogue's on the chains where it lists none —, each with its key, your metadata and the last reading of its contract.
- [Get an Asset](https://docs.aureahub.com/docs/asset-get.md): GET /v1/assets/{assetId}. One of your tenant's assets, or one of the catalogue's, by its id.
- [List Chains](https://docs.aureahub.com/docs/assets-chains.md): GET /v1/assets/chains. Every chain of Aurea's chain registry: its family, id and network, its native coin, whether Aurea has its own node for it, whether your tenant enabled it, and how many assets your tenant lists on it.
- [Register an Asset](https://docs.aureahub.com/docs/asset-register.md): POST /v1/assets. Add an EVM token to your tenant's assets by its contract alone: Aurea reads the contract on its chain and stores the token with the contract's own decimals — or refuses, and stores nothing.
- [Change Metadata](https://docs.aureahub.com/docs/asset-metadata-update.md): PATCH /v1/assets/{assetId}. Replace, or clear, your own keys and values on one of your tenant's assets — an ISIN, a desk, an internal code.
- [Check an Asset](https://docs.aureahub.com/docs/asset-check.md): POST /v1/assets/{assetId}/check. Read the contract of one of your EVM token assets on its chain again, and keep what it found on the asset: matched, or what differs.

## API Reference: Swap

- [Get Quote](https://docs.aureahub.com/docs/swap-quote.md): POST /v1/swap/quote. Step 1 of every swap — get a route from Aurea's swap router for a wallet, together with the `transactionData` you will execute.
- [Check Allowance](https://docs.aureahub.com/docs/swap-allowance.md): POST /v1/swap/check-allowance. Read the on-chain ERC-20 allowance a wallet has granted to a spender — typically the `approvalAddress` from the quote.
- [Approve Token](https://docs.aureahub.com/docs/swap-approve.md): POST /v1/swap/approve. Grant the swap spender — the quote's `approvalAddress` — an ERC-20 allowance on the source token.
- [Execute Swap](https://docs.aureahub.com/docs/swap-execute.md): POST /v1/swap/execute. Run a quoted swap from a wallet — sent immediately for custodial wallets, prepared for client signing for non-custodial wallets.
- [Simulate Swap](https://docs.aureahub.com/docs/swap-simulate.md): POST /v1/swap/simulate. Create a confirmed swap record without calling the swap router or any blockchain — for exercising swap UI and transaction-history flows.
- [Execute Gasless](https://docs.aureahub.com/docs/swap-gasless.md): POST /v1/swap/execute-gasless. Swap EUR.e for native xDAI on Gnosis, with the token approval supplied as an ERC-2612 permit instead of an approve transaction.
- [Broadcast Swap Tx](https://docs.aureahub.com/docs/swap-broadcast.md): POST /v1/swap/broadcast. Non-custodial EVM swaps, step 2 — submit the signature for the `txHashToSign` returned by Execute Swap.
- [Sign EIP-712 Permit](https://docs.aureahub.com/docs/swap-sign-permit.md): POST /v1/swap/sign-permit. Gasless swaps, step 2 — Aurea produces the EUR.e ERC-2612 permit for the wallet and returns its signature components.
- [Broadcast Approve Tx](https://docs.aureahub.com/docs/swap-broadcast-approve.md): POST /v1/swap/broadcast-approve. Non-custodial approvals, step 2 — submit the signature for the `txHashToSign` returned by Approve Token.
- [Broadcast Gasless Tx](https://docs.aureahub.com/docs/swap-broadcast-gasless.md): POST /v1/swap/broadcast-gasless. Gasless swaps for non-custodial wallets — submit the signature for the `txHashToSign` returned by Execute Gasless.
- [Execute Solana Swap](https://docs.aureahub.com/docs/swap-execute-solana.md): POST /v1/swap/execute-solana. Execute a quote whose source chain is Solana. This path is an alias of Execute Swap.
- [Broadcast Solana Swap](https://docs.aureahub.com/docs/swap-broadcast-solana.md): POST /v1/swap/broadcast-solana. A client-side wallet's Solana swap, step 2 — the wallet's signature of the message Execute Solana Swap handed out, checked and sent.

## API Reference: Bank Ramp: Pay-In

- [Onboarding Status](https://docs.aureahub.com/docs/payin-status.md): GET /v1/ramp/bank/payin/onboarding-status. Check whether the user has completed the bank ramp's onboarding (KYC) and can start EUR deposits.
- [Onboarding Session](https://docs.aureahub.com/docs/payin-session.md): POST /v1/ramp/bank/payin/onboard-session. Get a hosted onboarding (KYC) link for the user and send them there.
- [Sync KYC Status](https://docs.aureahub.com/docs/payin-sync-status.md): POST /v1/ramp/bank/payin/sync-status. Pull the user's latest onboarding and KYC status from the bank ramp and store it — useful right after the user returns from the hosted onboarding.
- [Currencies & Networks](https://docs.aureahub.com/docs/bank-currencies.md): GET /v1/ramp/bank/currencies. List the stablecoins and networks a user can receive from a bank deposit or sell for fiat, in the bank ramp's sandbox or in production.
- [What Your Tenant Offers](https://docs.aureahub.com/docs/bank-settings.md): GET /v1/ramp/bank/settings. Read what your tenant offers its users with the bank ramp in one environment — which functions are on, where pay-ins go, which currencies and networks, and the fees — so your app shows only what will work.
- [Open a Virtual Account](https://docs.aureahub.com/docs/payin-initiate.md): POST /v1/ramp/bank/payin/initiate. Assign the user a virtual IBAN: EUR bank transfers to it are converted by the bank ramp into crypto and sent to an on-chain address.
- [Payment Methods](https://docs.aureahub.com/docs/payin-methods.md): GET /v1/ramp/bank/payin/payment-methods. List the virtual IBANs assigned to the user, with the crypto route each one converts deposits into.
- [Deposits](https://docs.aureahub.com/docs/payin-deposits.md): GET /v1/ramp/bank/payin/deposits. List the EUR bank transfers the user has sent to their virtual IBANs.
- [Transactions](https://docs.aureahub.com/docs/payin-transactions.md): GET /v1/ramp/bank/payin/transactions. Retrieve the bank ramp transactions — conversions, on-chain deliveries, payouts and reversals — Aurea has recorded for the user, with the deposit that paid for them.
- [Simulate Deposit](https://docs.aureahub.com/docs/sandbox-deposit.md): POST /v1/ramp/bank/payin/sandbox/simulate-deposit. Ask the bank ramp's sandbox to simulate a bank transfer to a sandbox virtual account, in that account's own currency, to test your pay-in flow without real money.

## API Reference: Bank Ramp: Proven Addresses

- [Ask for a Challenge](https://docs.aureahub.com/docs/bank-address-challenge.md): POST /v1/ramp/bank/addresses/challenge. Get the message a user signs to prove they control an address outside Aurea — the first step of the standalone mode.
- [Verify an Address](https://docs.aureahub.com/docs/bank-address-verify.md): POST /v1/ramp/bank/addresses/verify. Send the signed challenge: a valid signature proves the address, and pay-ins can be delivered to it.
- [List Addresses](https://docs.aureahub.com/docs/bank-addresses-list.md): GET /v1/ramp/bank/addresses. The addresses outside Aurea that the user proved in one environment and still holds.
- [Revoke an Address](https://docs.aureahub.com/docs/bank-address-revoke.md): DELETE /v1/ramp/bank/addresses/{id}. Stop using an address the user proved: no new virtual IBAN can deliver to it.

## API Reference: Bank Ramp: Customers

- [Create a Customer](https://docs.aureahub.com/docs/bank-customer-create.md): POST /v1/ramp/bank/customer. Make the user a customer of the bank ramp in one environment — a person or a company — before your app sends their KYC data.
- [Get the Customer](https://docs.aureahub.com/docs/bank-customer-get.md): GET /v1/ramp/bank/customer. Read the user's customer as Aurea keeps it — its state, its sections and what the user does next.
- [Sync the Customer](https://docs.aureahub.com/docs/bank-customer-sync.md): POST /v1/ramp/bank/customer/sync. Have Aurea read the user's customer at the bank ramp now, and answer what it keeps.
- [Send Details](https://docs.aureahub.com/docs/bank-customer-details.md): PATCH /v1/ramp/bank/customer/details. Send who the customer is — a person's identity, or a company's registration and its people — for the bank ramp to review.
- [Send the Risk Form](https://docs.aureahub.com/docs/bank-customer-form.md): PATCH /v1/ramp/bank/customer/form. Send what the customer does, where their money comes from, how much they expect to move and where they pay tax.
- [Send Verifications](https://docs.aureahub.com/docs/bank-customer-verifications.md): PATCH /v1/ramp/bank/customer/verifications. Send the checks behind the customer's details — an identity document, a selfie match, a proof of address, the source of funds — each with the documents you uploaded.
- [Share a KYC Applicant](https://docs.aureahub.com/docs/bank-customer-share.md): POST /v1/ramp/bank/customer/share. With the `sumsub_sharing` strategy: hand the bank ramp the applicant your tenant already verified, instead of sending the details and identity checks again.
- [Upload a Document](https://docs.aureahub.com/docs/bank-customer-file-upload.md): POST /v1/ramp/bank/customer/files. Upload a document — an identity document's page, a proof of address, a company file — for the customer's verifications to name.
- [List Documents](https://docs.aureahub.com/docs/bank-customer-files.md): GET /v1/ramp/bank/customer/files. The documents uploaded for the user's customer in one environment, newest first.
- [Start Hosted Onboarding](https://docs.aureahub.com/docs/bank-customer-authorize.md): POST /v1/ramp/bank/customer/authorize. With the `hosted_oauth` strategy: get the link to the bank ramp's own pages, where the user signs up, completes their KYC and lets your tenant's application act for them.
- [Complete Hosted Onboarding](https://docs.aureahub.com/docs/bank-customer-authorize-complete.md): POST /v1/ramp/bank/customer/authorize/complete. Hand Aurea the `code` and `state` the bank ramp sent the user back with: the user becomes your tenant's customer.
- [Hosted Authorization](https://docs.aureahub.com/docs/bank-customer-authorization.md): GET /v1/ramp/bank/customer/authorize. Whether Aurea keeps the user's authorization at the bank ramp in one environment, and whether its last use failed.
- [Forget the Authorization](https://docs.aureahub.com/docs/bank-customer-authorization-forget.md): DELETE /v1/ramp/bank/customer/authorize. Have Aurea forget the user's authorization at the bank ramp in one environment.

## API Reference: Bank Ramp: Customer Addresses

- [Link a Wallet](https://docs.aureahub.com/docs/bank-customer-wallet-link.md): POST /v1/ramp/bank/customer/wallets. Link one of the user's Aurea wallets to their bank ramp customer on a chain, so the bank ramp pays to it and takes from it.
- [Send a Link Signature](https://docs.aureahub.com/docs/bank-customer-wallet-signature.md): POST /v1/ramp/bank/customer/wallets/{linkId}/signature. Send the wallet's signature of a link's message: Aurea checks it is the wallet's, then links the wallet at the bank ramp.
- [List Wallet Links](https://docs.aureahub.com/docs/bank-customer-wallets.md): GET /v1/ramp/bank/customer/wallets. The user's Aurea wallets linked, or being linked, to their bank ramp customer in one environment, newest first.
- [Ask for a Challenge](https://docs.aureahub.com/docs/bank-customer-address-challenge.md): POST /v1/ramp/bank/customer/addresses/challenge. Get the two messages an address outside Aurea signs to be proven to Aurea and linked to the user's bank ramp customer.
- [Prove and Link an Address](https://docs.aureahub.com/docs/bank-customer-address-verify.md): POST /v1/ramp/bank/customer/addresses/verify. Send an address's two signatures: Aurea checks both, keeps the address and links it to the user's bank ramp customer.
- [List Addresses](https://docs.aureahub.com/docs/bank-customer-addresses.md): GET /v1/ramp/bank/customer/addresses. The addresses the user proved and still uses with the bank ramp in one environment, newest first.
- [Stop Using an Address](https://docs.aureahub.com/docs/bank-customer-address-revoke.md): DELETE /v1/ramp/bank/customer/addresses/{id}. Revoke one of the user's proven addresses: Aurea no longer pays to it or takes from it with the bank ramp.

## API Reference: Bank Ramp: Payout

- [Countries](https://docs.aureahub.com/docs/payout-countries.md): GET /v1/ramp/bank/payout/countries. The countries where the bank ramp can pay out to the user, each with the fiat currencies it pays in.
- [Search Channels](https://docs.aureahub.com/docs/payout-channels.md): POST /v1/ramp/bank/payout/channels/search. The ways the bank ramp can pay out a cryptocurrency as fiat to a country and currency: fees, limits, processing time, the details the beneficiary needs and the user's saved accounts.
- [Channel Form](https://docs.aureahub.com/docs/payout-channel-form.md): POST /v1/ramp/bank/payout/channels/{channelId}/form. The beneficiary details a channel needs, as a JSON Schema to render or fill in.
- [Saved Beneficiaries](https://docs.aureahub.com/docs/payout-beneficiaries.md): GET /v1/ramp/bank/payout/beneficiaries. The bank accounts and other payment methods the user can be paid out to, read live from the bank ramp.
- [Create a Quote](https://docs.aureahub.com/docs/payout-quote.md): POST /v1/ramp/bank/payout/quotes. Price a payout to a bank account with the bank ramp: fees, the amount the beneficiary receives, the rate, and a quote that locks them.
- [Answer a Form Step](https://docs.aureahub.com/docs/payout-quote-step.md): POST /v1/ramp/bank/payout/quotes/{quoteId}/steps. Send the bank ramp the answers to the step a payout quote is waiting for, and get the next step or the ready quote.
- [Get a Quote](https://docs.aureahub.com/docs/payout-quote-get.md): GET /v1/ramp/bank/payout/quotes/{quoteId}. Read a payout quote as Aurea keeps it, without asking the bank ramp.
- [Pay from a Wallet](https://docs.aureahub.com/docs/payout-wallet-pay.md): POST /v1/ramp/bank/payout/payouts. Bind a payout quote whose rate is locked to a bank ramp payout rule, and get the deposit the user's own wallet must send.
- [List Wallet Payouts](https://docs.aureahub.com/docs/payout-wallet-list.md): GET /v1/ramp/bank/payout/payouts. The user's payouts paid from their own wallet, newest first, in one environment.
- [Get a Wallet Payout](https://docs.aureahub.com/docs/payout-wallet-get.md): GET /v1/ramp/bank/payout/payouts/{payoutId}. Read one payout paid from the user's own wallet, as Aurea keeps it, without asking the bank ramp.

## API Reference: Bank Ramp: Local Rails

- [Your Verification](https://docs.aureahub.com/docs/local-verification.md): GET /v1/ramp/bank/customer/verification. Whether the user may use the local rails in one environment, and what comes next.
- [Register](https://docs.aureahub.com/docs/local-verification-register.md): POST /v1/ramp/bank/customer/verification. Make the user a customer of the bank ramp's local rails — a person or a company — so the bank ramp verifies them.
- [Balances](https://docs.aureahub.com/docs/local-balances.md): GET /v1/ramp/bank/customer/balances. What the user holds on the local rails, per asset.
- [Banks & Mobile Money](https://docs.aureahub.com/docs/local-institutions.md): GET /v1/ramp/bank/customer/institutions. The institutions a withdrawal in an asset can pay, each with the id a withdrawal names.
- [Ask How to Pay In](https://docs.aureahub.com/docs/local-instruction-create.md): POST /v1/ramp/bank/customer/instructions. Give the user the account to pay and the exact amount to send, so the payment is recognised as theirs.
- [List Instructions](https://docs.aureahub.com/docs/local-instructions.md): GET /v1/ramp/bank/customer/instructions. The user's pay-in instructions, newest first.
- [Get an Instruction](https://docs.aureahub.com/docs/local-instruction-get.md): GET /v1/ramp/bank/customer/instructions/{id}. One of the user's pay-in instructions.
- [Cancel an Instruction](https://docs.aureahub.com/docs/local-instruction-cancel.md): POST /v1/ramp/bank/customer/instructions/{id}/cancel. Withdraw an open instruction the user no longer needs.
- [Sell a Stablecoin](https://docs.aureahub.com/docs/local-offramp-create.md): POST /v1/ramp/bank/customer/offramps. Record the user's sale of a stablecoin: the user's wallet sends it, and the bank ramp pays local currency to a bank account or a mobile money number.
- [List Sales](https://docs.aureahub.com/docs/local-offramps.md): GET /v1/ramp/bank/customer/offramps. The user's sales of stablecoin, newest first.
- [Get a Sale](https://docs.aureahub.com/docs/local-offramp-get.md): GET /v1/ramp/bank/customer/offramps/{id}. One of the user's sales of stablecoin.
- [Say It Was Sent](https://docs.aureahub.com/docs/local-offramp-sent.md): POST /v1/ramp/bank/customer/offramps/{id}/sent. Give the transaction hash of the user's transfer for a sale.
- [Cancel a Sale](https://docs.aureahub.com/docs/local-offramp-cancel.md): POST /v1/ramp/bank/customer/offramps/{id}/cancel. Cancel a sale whose stablecoin was not sent.
- [Stablecoin Deliveries](https://docs.aureahub.com/docs/local-deliveries.md): GET /v1/ramp/bank/customer/deliveries. Where each pay-in that asked for a stablecoin stands: converted, sent, delivered.
- [Withdraw](https://docs.aureahub.com/docs/local-withdrawal-create.md): POST /v1/ramp/bank/customer/withdrawals. Pay from the user's balance on the local rails to a bank account, a mobile money number or a wallet.
- [List Withdrawals](https://docs.aureahub.com/docs/local-withdrawals.md): GET /v1/ramp/bank/customer/withdrawals. The user's withdrawals, newest first.
- [Get a Withdrawal](https://docs.aureahub.com/docs/local-withdrawal-get.md): GET /v1/ramp/bank/customer/withdrawals/{id}. One of the user's withdrawals.

## API Reference: Bank Ramp: Desk

- [Corridors](https://docs.aureahub.com/docs/desk-corridors.md): GET /v1/ramp/bank/customer/desk/corridors. The desk currencies, their indicative rates in each direction, their minimum, and whether the desk takes orders now.
- [Quote an Order](https://docs.aureahub.com/docs/desk-quote.md): POST /v1/ramp/bank/customer/desk/quotes. Fix the rate of a desk order for about a minute: a stablecoin to a bank account (to_bank), or local currency from a bank to a stablecoin (from_bank).
- [Confirm an Order](https://docs.aureahub.com/docs/desk-confirm.md): POST /v1/ramp/bank/customer/desk/orders/{id}/confirm. Confirm a quoted desk order before its quote expires.
- [List Orders](https://docs.aureahub.com/docs/desk-orders.md): GET /v1/ramp/bank/customer/desk/orders. The user's desk orders, newest first.
- [Get an Order](https://docs.aureahub.com/docs/desk-order-get.md): GET /v1/ramp/bank/customer/desk/orders/{id}. One of the user's desk orders.
- [Upload a Proof](https://docs.aureahub.com/docs/desk-proof-upload.md): PUT /v1/ramp/bank/customer/desk/orders/{id}/proof. Send the receipt of the user's bank payment for a from_bank order.
- [Proof Link](https://docs.aureahub.com/docs/desk-proof-link.md): GET /v1/ramp/bank/customer/desk/orders/{id}/proof. A signed link to the proof uploaded for an order, valid for about five minutes.
- [Ask to Cancel](https://docs.aureahub.com/docs/desk-cancellation.md): POST /v1/ramp/bank/customer/desk/orders/{id}/cancellation. Ask the desk to cancel an order; the desk decides.

## API Reference: Card Onramp

- [Configuration](https://docs.aureahub.com/docs/card-onramp-config.md): GET /v1/ramp/card/config. Whether the user's tenant offers card-to-crypto in an environment, and what the app needs to offer it.
- [Quotes](https://docs.aureahub.com/docs/card-onramp-quotes.md): GET /v1/ramp/card/quotes. the price for the pairs your tenant offers, before the widget opens.
- [Open a Session](https://docs.aureahub.com/docs/card-onramp-create.md): POST /v1/ramp/card/sessions. A card onramp session that delivers crypto to one of the user's wallets, and the client secret that opens the payment widget.
- [Get a Session](https://docs.aureahub.com/docs/card-onramp-get.md): GET /v1/ramp/card/sessions/{id}. One of the user's sessions, as the payment provider sees it now.
- [List Sessions](https://docs.aureahub.com/docs/card-onramp-list.md): GET /v1/ramp/card/sessions. The user's sessions in one environment, newest first.
- [Hosted Page Link](https://docs.aureahub.com/docs/card-onramp-hosted-link.md): POST /v1/ramp/card/sessions/{id}/hosted-link. A link to Aurea's hosted page for one of the user's open sessions, for an app with no web page of its own.
- [Hosted Page Read](https://docs.aureahub.com/docs/card-onramp-hosted-session.md): POST /v1/ramp/card/hosted/session. What the hosted page reads with its link's token. The page calls it itself; your app never needs to.
- [Address Challenge](https://docs.aureahub.com/docs/card-onramp-address-challenge.md): POST /v1/ramp/card/addresses/challenge. The message a user signs to prove they control an address the onramp may deliver to.
- [Verify an Address](https://docs.aureahub.com/docs/card-onramp-address-verify.md): POST /v1/ramp/card/addresses/verify. Keep the address a signed challenge proves.
- [Proven Addresses](https://docs.aureahub.com/docs/card-onramp-addresses.md): GET /v1/ramp/card/addresses. The addresses the user proved in one environment and still holds.
- [Revoke an Address](https://docs.aureahub.com/docs/card-onramp-address-revoke.md): DELETE /v1/ramp/card/addresses/{id}. Stop using an address the user proved.

## API Reference: Card Onramp: Your Wallets

- [Name an End User](https://docs.aureahub.com/docs/card-wallets-customer-put.md): PUT /v1/ramp/card/customers/{externalId}. Make, or read, one of your end users by your own id. Optional: the wallet and purchase calls make the end user too.
- [Get an End User](https://docs.aureahub.com/docs/card-wallets-customer-get.md): GET /v1/ramp/card/customers/{externalId}. One of your end users and the wallets you attested for it, in both environments.
- [Attest a Default Wallet](https://docs.aureahub.com/docs/card-wallets-wallet-put.md): PUT /v1/ramp/card/customers/{externalId}/wallets/{family}. The wallet a purchase of that family uses when it names no address, in one environment.
- [Revoke a Default Wallet](https://docs.aureahub.com/docs/card-wallets-wallet-delete.md): DELETE /v1/ramp/card/customers/{externalId}/wallets/{family}. Stop using the end user's default wallet of one family in one environment.
- [Open a Purchase](https://docs.aureahub.com/docs/card-wallets-session-create.md): POST /v1/ramp/card/customers/{externalId}/sessions. A card purchase for your end user, to the wallet the call names or to its default wallet of the pair's family.
- [List Purchases](https://docs.aureahub.com/docs/card-wallets-sessions-list.md): GET /v1/ramp/card/customers/{externalId}/sessions. The end user's purchases in one environment, newest first.
- [Get a Purchase](https://docs.aureahub.com/docs/card-wallets-session-get.md): GET /v1/ramp/card/customers/{externalId}/sessions/{id}. One of the end user's purchases as it stands now.

## API Reference: Cards: Sign-In & Onboarding

- [Local Status](https://docs.aureahub.com/docs/cards-local-status.md): GET /v1/gnosis/local-status. Where the user stands, from Aurea's own records — no call to the card program, so it never fails on an expired session. Call it whenever your app opens.
- [Sign-In Nonce](https://docs.aureahub.com/docs/cards-auth-nonce.md): GET /v1/gnosis/auth/nonce. A one-time nonce for the user's sign-in to the card program: step 1 of the session ([Cards & EUR Account](https://docs.aureahub.com/docs/guide-cards.md) › The Card Program Session).
- [Sign In](https://docs.aureahub.com/docs/cards-auth-challenge.md): POST /v1/gnosis/auth/challenge. Send the signed sign-in message. Aurea opens and keeps the user's card program session.
- [Sign Up](https://docs.aureahub.com/docs/cards-auth-signup.md): POST /v1/gnosis/auth/signup. Register the signed-in user with the card program, after [Sign In](https://docs.aureahub.com/docs/cards-auth-challenge.md) answered `isExistingGnosisUser` `false`.
- [End the Session](https://docs.aureahub.com/docs/cards-session-clear.md): DELETE /v1/gnosis/session. Forget the user's card program session, for example when they sign out of your app.
- [Get the Account](https://docs.aureahub.com/docs/cards-user.md): GET /v1/gnosis/user. The user's account at the card program: where onboarding stands, the smart account and the EUR account.
- [Terms](https://docs.aureahub.com/docs/cards-terms-get.md): GET /v1/gnosis/user/terms. The terms the user is asked to accept, with whether each one is.
- [Accept Terms](https://docs.aureahub.com/docs/cards-terms-accept.md): POST /v1/gnosis/user/terms. Record the user's acceptance of one of the card program's terms.
- [Identity Check](https://docs.aureahub.com/docs/cards-kyc.md): GET /v1/gnosis/kyc/integration. Where the user completes the card program's identity check.
- [Source of Funds Questions](https://docs.aureahub.com/docs/cards-sof-get.md): GET /v1/gnosis/source-of-funds. The questions on where the user's money comes from, each with the answers to choose from.
- [Answer Source of Funds](https://docs.aureahub.com/docs/cards-sof-submit.md): POST /v1/gnosis/source-of-funds. Send the user's answers to the source of funds questions.
- [Send a Phone Code](https://docs.aureahub.com/docs/cards-phone-start.md): POST /v1/gnosis/verification. Send a one-time code to the user's phone number, to verify it.
- [Check the Phone Code](https://docs.aureahub.com/docs/cards-phone-check.md): POST /v1/gnosis/verification/check. Send the code the user received, to complete the phone verification.
- [Smart Account](https://docs.aureahub.com/docs/cards-account-config.md): GET /v1/gnosis/safe-config. The user's smart account on Gnosis Chain, once it exists: the account the card spends from and the EUR account pays into.
- [Create the Smart Account](https://docs.aureahub.com/docs/cards-account-deploy.md): POST /v1/gnosis/safe/deploy. Create the user's smart account on Gnosis Chain — the last onboarding step.

## API Reference: Cards: EUR Account & Payouts

- [IBAN Signing Message](https://docs.aureahub.com/docs/cards-iban-message.md): GET /v1/gnosis/ibans/signing-message. The message the user's wallet signs to activate their EUR account with a signature.
- [Activate the EUR Account](https://docs.aureahub.com/docs/cards-iban-activate.md): POST /v1/gnosis/integrations/monerium. Activate the user's EUR account, with a signature or with the consent they gave on the issuer's page.
- [Authorization Link](https://docs.aureahub.com/docs/cards-iban-authorize.md): GET /v1/gnosis/monerium/authorize-url. The link to the issuer's consent page, where the user lets your app pay out from their EUR account. Called twice: phase 1 gets what to sign, phase 2 the link to open.
- [Link Message](https://docs.aureahub.com/docs/cards-link-message.md): GET /v1/gnosis/monerium/link-message. The message that proves the user owns the address their EUR account pays out from.
- [Link the Address](https://docs.aureahub.com/docs/cards-link-address.md): POST /v1/gnosis/monerium/link-safe. Link the address that signs payouts — and the user's smart account — to their EUR account.
- [Payout Message](https://docs.aureahub.com/docs/cards-payout-message.md): GET /v1/gnosis/payout/message. The exact message the user signs to pay out euros from their EUR account to a bank account — step 1 of a payout.
- [Pay Out to a Bank](https://docs.aureahub.com/docs/cards-payout.md): POST /v1/gnosis/payout. Send euros from the user's EUR account to a bank account by SEPA transfer: EURe leaves their smart account, euros reach the IBAN.

## API Reference: Cards: Your Cards

- [List Cards](https://docs.aureahub.com/docs/cards-list.md): GET /v1/gnosis/cards. The user's cards.
- [Create a Virtual Card](https://docs.aureahub.com/docs/cards-virtual-create.md): POST /v1/gnosis/cards/virtual. Issue a virtual card to the user, ready to use.
- [Activate](https://docs.aureahub.com/docs/cards-activate.md): POST /v1/gnosis/cards/{cardId}/activate. Activate one of the user's cards that is not active yet (`statusCode` `1001`). The answer is the card program's (`{}` when it answered no body), passed through unchanged; the example is illustrative; read the card again with [List Cards](https://docs.aureahub.com/docs/cards-list.md).
- [Freeze](https://docs.aureahub.com/docs/cards-freeze.md): POST /v1/gnosis/cards/{cardId}/freeze. Stop a card from paying until it is unfrozen ([Unfreeze](https://docs.aureahub.com/docs/cards-unfreeze.md)). The answer is the card program's (`{}` when it answered no body), passed through unchanged; the example is illustrative.
- [Unfreeze](https://docs.aureahub.com/docs/cards-unfreeze.md): POST /v1/gnosis/cards/{cardId}/unfreeze. Let a frozen card pay again. The answer is the card program's (`{}` when it answered no body), passed through unchanged; the example is illustrative.
- [Void](https://docs.aureahub.com/docs/cards-void.md): POST /v1/gnosis/cards/{cardId}/void. Cancel a card for good — for example a lost one. It cannot be used again: create a new card instead. The answer is the card program's (`{}` when it answered no body), passed through unchanged; the example is illustrative.
- [Card Transactions](https://docs.aureahub.com/docs/cards-transactions.md): GET /v1/gnosis/cards/transactions. The payments made with the user's cards, as the card program records them.
- [Card Reveal Token](https://docs.aureahub.com/docs/cards-reveal-token.md): GET /v1/gnosis/cards/ephemeral-token. The token that lets the user see a card's details — number, expiry, security code — in the card program's secure display component, inside your app. The details never pass through your servers or Aurea's.

## API Reference: Earn

- [Products](https://docs.aureahub.com/docs/earn-products.md): GET /v1/earn/products. The Earn products your tenant offers on a network, each with its state and rate on every chain it is on.
- [Disclosure](https://docs.aureahub.com/docs/earn-disclosure.md): GET /v1/earn/products/{productId}/disclosure. The text the user reads, and accepts, before their first deposit into a product.
- [Accept a Disclosure](https://docs.aureahub.com/docs/earn-disclosure-accept.md): POST /v1/earn/products/{productId}/disclosure/acceptances. Records that the user accepted the disclosure they were shown.
- [Quote](https://docs.aureahub.com/docs/earn-quote.md): GET /v1/earn/quote. What a deposit or a withdrawal would do, before the user commits to it.
- [Deposit](https://docs.aureahub.com/docs/earn-deposit.md): POST /v1/earn/deposits. Deposits an amount of the product's asset from one of the user's wallets.
- [Withdraw](https://docs.aureahub.com/docs/earn-withdraw.md): POST /v1/earn/withdrawals. Withdraws an amount, or the whole position, to the wallet the position is held by.
- [Send Signatures](https://docs.aureahub.com/docs/earn-broadcast.md): POST /v1/earn/operations/{operationId}/broadcast. The client's signatures of an operation answered `submitted`; Aurea sends the steps exactly as it built them.
- [List Operations](https://docs.aureahub.com/docs/earn-operations.md): GET /v1/earn/operations. The user's deposits and withdrawals on a network, newest first.
- [Get an Operation](https://docs.aureahub.com/docs/earn-operation-get.md): GET /v1/earn/operations/{operationId}. One of the user's operations, brought up to date first.
- [Positions](https://docs.aureahub.com/docs/earn-positions.md): GET /v1/earn/positions. What the user holds in the Earn products, read from the chain.

## API Reference: Lending

- [Positions](https://docs.aureahub.com/docs/lending-positions.md): GET /v1/aave/positions. The user's lending position on each lending chain, the pool's current rate and what is still in the wallet.
- [Rate History](https://docs.aureahub.com/docs/lending-rate-history.md): GET /v1/aave/rate-history. The pool's yearly rate over the last 90 days, for a chart.
- [Supply](https://docs.aureahub.com/docs/lending-supply.md): POST /v1/aave/supply. Supply EUR.e from the user's custodial wallet to the lending pool. Aurea signs and sends, and answers once the supply is mined.
- [Withdraw](https://docs.aureahub.com/docs/lending-withdraw.md): POST /v1/aave/withdraw. Withdraw EUR.e from the lending pool back to the user's custodial wallet — an amount, or the whole position with its interest.
- [Prepare a Supply](https://docs.aureahub.com/docs/lending-prepare-supply.md): POST /v1/aave/prepare-supply. The unsigned transactions of a supply, for a wallet the user signs for — client-side or MPC.
- [Prepare a Withdrawal](https://docs.aureahub.com/docs/lending-prepare-withdraw.md): POST /v1/aave/prepare-withdraw. The unsigned transaction of a withdrawal, for a wallet the user signs for — client-side or MPC.
- [Send the Signatures](https://docs.aureahub.com/docs/lending-broadcast.md): POST /v1/aave/broadcast. Send a prepared supply or withdrawal, signed by the user's wallet. Aurea checks each signature and sends the steps in order.

## API Reference: Tokenized Assets: Catalogue

- [List Assets](https://docs.aureahub.com/docs/tok-assets-list.md): GET /v1/tokenized-assets. The tokenized assets your tenant offers in an environment.
- [Get an Asset](https://docs.aureahub.com/docs/tok-asset-get.md): GET /v1/tokenized-assets/assets/{symbol}. One asset as the list gives it, with its details where it has them.
- [Multipliers per Chain](https://docs.aureahub.com/docs/tok-asset-multipliers.md): GET /v1/tokenized-assets/assets/{symbol}/multipliers. How much of the underlying one token stands for on each chain, the next value announced, and every change before.
- [Supply](https://docs.aureahub.com/docs/tok-asset-supply.md): GET /v1/tokenized-assets/assets/{symbol}/supply. The tokens of an asset in circulation and in total, across every chain.
- [Reserves](https://docs.aureahub.com/docs/tok-asset-reserves.md): GET /v1/tokenized-assets/assets/{symbol}/reserves. The shares of the underlying held for the tokens in circulation, by custodian, as last attested.
- [Price Feeds](https://docs.aureahub.com/docs/tok-asset-oracles.md): GET /v1/tokenized-assets/assets/{symbol}/oracles. The on-chain price feeds of an asset's token on the chains served.
- [Corporate-Action Calendar](https://docs.aureahub.com/docs/tok-asset-ca-calendar.md): GET /v1/tokenized-assets/assets/{symbol}/corporate-actions/calendar. The corporate actions an asset's issuer announced, upcoming and past.
- [Corporate Actions](https://docs.aureahub.com/docs/tok-asset-corporate-actions.md): GET /v1/tokenized-assets/assets/{symbol}/corporate-actions. What Aurea knows of an asset — paused or not on each chain, its multiplier, its latest dividend — and the corporate actions it saw.

## API Reference: Tokenized Assets: Market Data

- [Market Status](https://docs.aureahub.com/docs/tok-market-status.md): GET /v1/tokenized-assets/market/status. Whether the market of the tokenized shares and ETFs is open now, its session, and when it opens and closes next.
- [Latest Prices](https://docs.aureahub.com/docs/tok-market-prices.md): GET /v1/tokenized-assets/market/prices. The latest price of every tokenized asset your tenant offers, with its change over the last 24 hours of open market.
- [Tickers](https://docs.aureahub.com/docs/tok-market-tickers.md): GET /v1/tokenized-assets/market/tickers. The last price and the 24-hour volumes of every tokenized asset your tenant offers, against the token trades settle in.
- [Paused & Limited Assets](https://docs.aureahub.com/docs/tok-market-asset-statuses.md): GET /v1/tokenized-assets/market/asset-statuses. The tokenized assets your tenant offers whose trading is paused or limited, now or on a schedule.
- [Asset Price](https://docs.aureahub.com/docs/tok-asset-price.md): GET /v1/tokenized-assets/assets/{symbol}/price. An asset's latest price, and its underlying instrument's.
- [Candles](https://docs.aureahub.com/docs/tok-asset-candles.md): GET /v1/tokenized-assets/assets/{symbol}/candles. Open, high, low and close of an asset, and of its underlying instrument, for an interval over a range.
- [Market Data](https://docs.aureahub.com/docs/tok-asset-market.md): GET /v1/tokenized-assets/assets/{symbol}/market. An asset's price and change, its last 24 hours, its holders, its shares multiplier and sessions, and its underlying instrument's fundamentals.
- [Latest Dividend](https://docs.aureahub.com/docs/tok-asset-dividends.md): GET /v1/tokenized-assets/assets/{symbol}/dividends. The underlying instrument's dividend yield, frequency and last payment.
- [Shares Multiplier](https://docs.aureahub.com/docs/tok-asset-multiplier.md): GET /v1/tokenized-assets/assets/{symbol}/multiplier. How many shares of the underlying one token stands for now, and how that changed.
- [Asset Status](https://docs.aureahub.com/docs/tok-asset-status.md): GET /v1/tokenized-assets/assets/{symbol}/status. Whether an asset's trading is paused or limited, with its pauses.

## API Reference: Tokenized Assets: Eligibility

- [My Eligibility](https://docs.aureahub.com/docs/tok-eligibility.md): GET /v1/tokenized-assets/eligibility. What your tenant supplied about the signed-in user for tokenized assets, item by item.
- [A User's Eligibility](https://docs.aureahub.com/docs/tok-user-eligibility-get.md): GET /v1/tokenized-assets/users/{userId}/eligibility. What your tenant supplied about one of its users, with who supplied each item.
- [Supply Eligibility](https://docs.aureahub.com/docs/tok-user-eligibility-supply.md): PATCH /v1/tokenized-assets/users/{userId}/eligibility. Your tenant, as the authorised entity, supplies one or more items of a user's eligibility.
- [Asset Documents](https://docs.aureahub.com/docs/tok-documents.md): GET /v1/tokenized-assets/assets/{symbol}/documents. The documents the user reads and accepts before trading an asset, in their current version.
- [Accept a Document](https://docs.aureahub.com/docs/tok-document-accept.md): POST /v1/tokenized-assets/assets/{symbol}/documents/acceptances. Records that the user accepted the document they were shown.
- [Requirements](https://docs.aureahub.com/docs/tok-requirements.md): GET /v1/tokenized-assets/assets/{symbol}/requirements. Whether the signed-in user can trade an asset now, and if not, why.

## API Reference: Tokenized Assets: Quotes & Orders

- [Trading Limits](https://docs.aureahub.com/docs/tok-limits.md): GET /v1/tokenized-assets/assets/{symbol}/limits. The limits an order of an asset meets now: the market's, and your tenant's own.
- [Indicative Quote](https://docs.aureahub.com/docs/tok-quote-indicative.md): POST /v1/tokenized-assets/quotes/indicative. What an order would trade at now, and what it would cost or pay after your tenant's fee.
- [Binding Quote](https://docs.aureahub.com/docs/tok-quote-create.md): POST /v1/tokenized-assets/quotes. A quote that holds until it expires, kept by Aurea for the execution of the order.
- [Get a Quote](https://docs.aureahub.com/docs/tok-quote-get.md): GET /v1/tokenized-assets/quotes/{quoteId}. One of the signed-in user's binding quotes: its terms and its status.
- [Execute a Quote](https://docs.aureahub.com/docs/tok-quote-execute.md): POST /v1/tokenized-assets/quotes/{quoteId}/execute. Carries out one of the user's binding quotes on chain, exactly as it was signed.
- [Place a Limit Order](https://docs.aureahub.com/docs/tok-limit-order.md): POST /v1/tokenized-assets/limit-orders. An order placed on chain from the user's own wallet, filled later at the limit price or better — or not at all before it expires.

## API Reference: Tokenized Assets: Operations

- [List Operations](https://docs.aureahub.com/docs/tok-operations-list.md): GET /v1/tokenized-assets/operations. The signed-in user's tokenized assets operations in an environment, newest first.
- [Get an Operation](https://docs.aureahub.com/docs/tok-operation-get.md): GET /v1/tokenized-assets/operations/{operationId}. One of the signed-in user's operations, brought up to date from the chain while it is not over.
- [Send Signatures](https://docs.aureahub.com/docs/tok-operation-broadcast.md): POST /v1/tokenized-assets/operations/{operationId}/broadcast. The signatures of an operation a wallet's owner signs for, one per step, in order.

## API Reference: Tokenized Assets: Yield Token

- [Yield Token Price](https://docs.aureahub.com/docs/tok-yield-price.md): GET /v1/tokenized-assets/yield/price. The yield-bearing dollar token's price, read on chain.
- [Buy the Yield Token](https://docs.aureahub.com/docs/tok-yield-subscribe.md): POST /v1/tokenized-assets/yield/subscriptions. The yield token, or its rebasing form, bought with USDC on Ethereum.
- [Sell the Yield Token](https://docs.aureahub.com/docs/tok-yield-redeem.md): POST /v1/tokenized-assets/yield/redemptions. The yield token, or its rebasing form, sold for USDC on Ethereum.
- [Convert the Yield Token](https://docs.aureahub.com/docs/tok-yield-convert.md): POST /v1/tokenized-assets/yield/conversions. The yield token wrapped into its rebasing form, or the rebasing form unwrapped back into whole tokens.

## API Reference: Tokenized Assets: Secondary Market

- [Secondary Quote](https://docs.aureahub.com/docs/tok-secondary-quote.md): POST /v1/tokenized-assets/secondary/quotes. A quote of the secondary market for an asset, paid from and delivered to one of the user's own wallets.
- [Get a Secondary Quote](https://docs.aureahub.com/docs/tok-secondary-quote-get.md): GET /v1/tokenized-assets/secondary/quotes/{quoteId}. One of the user's own secondary-market quotes, in the environment asked.
- [Approve the Payment](https://docs.aureahub.com/docs/tok-secondary-approve.md): POST /v1/tokenized-assets/secondary/quotes/{quoteId}/approve. Allows the swap exactly the amount the quote pays, from the quote's wallet.
- [Execute the Swap](https://docs.aureahub.com/docs/tok-secondary-execute.md): POST /v1/tokenized-assets/secondary/quotes/{quoteId}/execute. The swap the quote kept, carried out once, within its time.
- [Send a Signed Step](https://docs.aureahub.com/docs/tok-secondary-broadcast.md): POST /v1/tokenized-assets/secondary/quotes/{quoteId}/broadcast. The signature of a step the quote prepared — its approval, or its swap — checked and sent.

## API Reference: Your Webhooks

- [List Webhooks](https://docs.aureahub.com/docs/tenant-webhooks-list.md): GET /v1/admin/tenants/{id}/webhooks. The webhooks that tell your server about bank ramp and card onramp events, one per environment, without their secrets.
- [Save a Webhook](https://docs.aureahub.com/docs/tenant-webhook-save.md): PUT /v1/admin/tenants/{id}/webhooks/{environment}. Make or change the webhook of one environment. The secret is shown when the webhook is made, and never again.
- [Replace the Secret](https://docs.aureahub.com/docs/tenant-webhook-rotate.md): POST /v1/admin/tenants/{id}/webhooks/{environment}/rotate-secret. A new secret for the webhook of one environment, shown once. It signs every delivery from now on.
- [Send a Test](https://docs.aureahub.com/docs/tenant-webhook-test.md): POST /v1/admin/tenants/{id}/webhooks/{environment}/test. One signed `webhook.test` to the webhook of one environment, right now, with what happened.
- [Remove a Webhook](https://docs.aureahub.com/docs/tenant-webhook-remove.md): DELETE /v1/admin/tenants/{id}/webhooks/{environment}. Stop telling your server about bank ramp and card onramp events in one environment.

## API Reference: Webhook Endpoints

- [List Endpoints](https://docs.aureahub.com/docs/webhook-endpoints-list.md): GET /v1/admin/tenants/{id}/webhook-endpoints. Your tenant's webhook endpoints, without their secrets, and every event type an endpoint may ask for.
- [Add an Endpoint](https://docs.aureahub.com/docs/webhook-endpoint-add.md): POST /v1/admin/tenants/{id}/webhook-endpoints. One more address for your tenant's events in one environment, with the event types it asks for. Its secret is shown in this answer, and never again.
- [Change an Endpoint](https://docs.aureahub.com/docs/webhook-endpoint-change.md): PATCH /v1/admin/tenants/{id}/webhook-endpoints/{endpointId}. Its address, its event types, its label, its status or its mutual TLS. The rest stays, and so does the secret.
- [Endpoint: New Secret](https://docs.aureahub.com/docs/webhook-endpoint-rotate.md): POST /v1/admin/tenants/{id}/webhook-endpoints/{endpointId}/rotate-secret. A new secret for one endpoint, shown once. It signs every delivery to that endpoint from now on.
- [Endpoint: Send a Test](https://docs.aureahub.com/docs/webhook-endpoint-test.md): POST /v1/admin/tenants/{id}/webhook-endpoints/{endpointId}/test. One signed `webhook.test` to one endpoint, right now, with what happened.
- [Remove an Endpoint](https://docs.aureahub.com/docs/webhook-endpoint-remove.md): DELETE /v1/admin/tenants/{id}/webhook-endpoints/{endpointId}. Stop sending events to one endpoint, for good.
- [List Deliveries](https://docs.aureahub.com/docs/webhook-deliveries-list.md): GET /v1/admin/tenants/{id}/webhook-deliveries. What Aurea sent, or is sending, to your tenant's addresses: one row per event and address, newest first.
- [Attempts Log](https://docs.aureahub.com/docs/webhook-attempts-list.md): GET /v1/admin/tenants/{id}/webhook-attempts. Every attempt Aurea made to post a delivery to your tenant's addresses: when, how long, and what your server answered — or why no answer came.
- [Send Again](https://docs.aureahub.com/docs/webhook-deliveries-resend.md): POST /v1/admin/tenants/{id}/webhook-deliveries/resend. Put your tenant's deliveries back in the queue with a fresh set of attempts: one event's, those of a time range, or every one that failed.
- [Client Certificate](https://docs.aureahub.com/docs/webhook-client-certificate.md): GET /v1/webhooks/client-certificate. The certificate Aurea presents on the deliveries to an endpoint that asks for mutual TLS: have your server require it.

## API Reference: Audit Trail

- [List Audit Events](https://docs.aureahub.com/docs/audit-events.md): GET /v1/audit-events. What was done to your tenant's money, keys, governance, security, settings and access, by whom and on what — newest first.

## API Reference: Reports

- [Ask for a Report](https://docs.aureahub.com/docs/report-request.md): POST /v1/admin/tenants/{id}/reports. A file of your tenant's movements, balances, addresses or approvals, made in the background.
- [List Reports](https://docs.aureahub.com/docs/reports-list.md): GET /v1/admin/tenants/{id}/reports. Your tenant's reports, newest first.
- [Get a Report](https://docs.aureahub.com/docs/report-get.md): GET /v1/admin/tenants/{id}/reports/{reportId}. A report's status and, once it is ready, a new signed link to its file.
- [Download a Report](https://docs.aureahub.com/docs/report-download.md): GET /v1/admin/tenants/{id}/reports/{reportId}/download. The report's file, through the signed link its read answered — no token needed.

## API Reference: Freezes & Quarantines

- [Freeze](https://docs.aureahub.com/docs/freezes-create.md): POST /v1/admin/tenants/{id}/freezes. Stop one of your tenant's users, one of its wallets, or the wallets of one of its accounts, on every server, from the moment this answers.
- [List Freezes](https://docs.aureahub.com/docs/freezes-list.md): GET /v1/admin/tenants/{id}/freezes. Your tenant's freezes, newest first — the tenant's own included, if Aurea placed one.
- [Lift a Freeze](https://docs.aureahub.com/docs/freeze-lift.md): POST /v1/admin/tenants/{id}/freezes/{freezeId}/lift. Let a frozen user, wallet or account act again, on every server, from the moment this answers.
- [Quarantine](https://docs.aureahub.com/docs/quarantines-create.md): POST /v1/admin/tenants/{id}/quarantines. Hold one pending operation of your tenant before anything of it is signed or sent, until the quarantine is lifted.
- [List Quarantines](https://docs.aureahub.com/docs/quarantines-list.md): GET /v1/admin/tenants/{id}/quarantines. Your tenant's quarantined operations, newest first.
- [Lift a Quarantine](https://docs.aureahub.com/docs/quarantine-lift.md): POST /v1/admin/tenants/{id}/quarantines/{quarantineId}/lift. Let a quarantined operation go on from where it waited.

## API Reference: AML Cases

- [List Cases](https://docs.aureahub.com/docs/aml-cases-list.md): GET /v1/aml-cases. Your tenant's AML cases — the sanctions-list matches its screening held or refused —, newest first.
- [Get a Case](https://docs.aureahub.com/docs/aml-case-get.md): GET /v1/aml-cases/{caseId}. One case, with its screening, its decision and its comments.
- [Assign](https://docs.aureahub.com/docs/aml-case-assign.md): POST /v1/aml-cases/{caseId}/assign. Who works an open case — or nobody.
- [Comment](https://docs.aureahub.com/docs/aml-case-comment.md): POST /v1/aml-cases/{caseId}/comments. A note kept with the case, for whoever works it.
- [Decide](https://docs.aureahub.com/docs/aml-case-decide.md): POST /v1/aml-cases/{caseId}/decision. Release the match, or confirm it — once, with a written reason.

## API Reference: Policy Sets

- [List Policy Sets](https://docs.aureahub.com/docs/policy-sets-list.md): GET /v1/policy-sets. Your tenant's policy sets — each a version of its signing policy — newest first, without their rules.
- [Create a Draft](https://docs.aureahub.com/docs/policy-set-create.md): POST /v1/policy-sets. A new draft, the tenant's next version: empty, with the rules you give, or a copy of any version's rules.
- [Get a Policy Set](https://docs.aureahub.com/docs/policy-set-get.md): GET /v1/policy-sets/{setId}. One version with its rules, in the order they are evaluated.
- [Replace Rules](https://docs.aureahub.com/docs/policy-set-rules.md): PUT /v1/policy-sets/{setId}/rules. The draft's rules, replaced by these, in their order.
- [Validate](https://docs.aureahub.com/docs/policy-set-validate.md): POST /v1/policy-sets/{setId}/validate. Errors that stop a submission, and warnings that don't. Changes nothing.
- [Simulate](https://docs.aureahub.com/docs/policy-set-simulate.md): POST /v1/policy-sets/{setId}/simulate. What a set would have decided on your tenant's past operations, at each operation's own time. Changes nothing.
- [Submit](https://docs.aureahub.com/docs/policy-set-submit.md): POST /v1/policy-sets/{setId}/submit. `draft` → `awaiting_quorum`, once valid. From then on the version never changes.
- [Publish](https://docs.aureahub.com/docs/policy-set-publish.md): POST /v1/policy-sets/{setId}/publish. `awaiting_quorum` → `active`: the set becomes the tenant's policy, and the one it replaces is archived.
- [Withdraw](https://docs.aureahub.com/docs/policy-set-archive.md): POST /v1/policy-sets/{setId}/archive. A draft, or a set awaiting its quorum, → `archived`.
- [Roll Back](https://docs.aureahub.com/docs/policy-set-rollback.md): POST /v1/policy-sets/{setId}/rollback. Publish a version that was once active again, as a new version.

## API Reference: Approvals

- [List Approval Keys](https://docs.aureahub.com/docs/approval-keys-list.md): GET /v1/approval-keys. The public keys you sign your approvals with, newest first — revoked ones included.
- [Register a Key](https://docs.aureahub.com/docs/approval-key-register.md): POST /v1/approval-keys. The public half of a P-256 key pair you made: the key your approvals are checked with. The private key stays with you.
- [Revoke a Key](https://docs.aureahub.com/docs/approval-key-revoke.md): POST /v1/approval-keys/{keyId}/revoke. For good: decisions signed with it are refused from now on.
- [Waiting for You](https://docs.aureahub.com/docs/approvals-inbox.md): GET /v1/approvals. The approval requests you may decide now, newest first.
- [Get a Request](https://docs.aureahub.com/docs/approval-get.md): GET /v1/approvals/{operationId}. An operation's approval request, its decisions, whether you may decide it now, and the two payloads a decision signs.
- [Approve](https://docs.aureahub.com/docs/approval-approve.md): POST /v1/approvals/{operationId}/approve. Your approval, signed with one of your approval keys or confirmed with your passkey. Once the rule's threshold of distinct approvers approved, the operation goes on.
- [Reject](https://docs.aureahub.com/docs/approval-reject.md): POST /v1/approvals/{operationId}/reject. Your rejection, signed with one of your approval keys or confirmed with your passkey. One rejection ends the request: nothing is signed or sent.

## API Reference: Institution Callback

- [Get the Settings](https://docs.aureahub.com/docs/institution-callback-get.md): GET /v1/admin/tenants/{id}/institution-callback. Your tenant's callback settings, both environments at once.
- [Change the Settings](https://docs.aureahub.com/docs/institution-callback-put.md): PUT /v1/admin/tenants/{id}/institution-callback/{environment}. Save one environment's callback: its mode, your endpoint, your answer keys, the fallback, the RETRY window and the approval requests.
- [Send a Test](https://docs.aureahub.com/docs/institution-callback-test.md): POST /v1/admin/tenants/{id}/institution-callback/{environment}/test. Aurea sends your endpoint one signed request of kind `test` and tells you what it answered.
- [List Requests](https://docs.aureahub.com/docs/institution-callback-requests.md): GET /v1/admin/tenants/{id}/institution-callback/requests. What Aurea asked your endpoint, newest first: each request's status, attempts and the decisive answer's hash.
- [Aurea's Request Keys](https://docs.aureahub.com/docs/institution-callback-jwks.md): GET /v1/institution-callbacks/jwks.json. The public keys that verify the requests Aurea sends your institution callback.

## API Reference: Groups

- [List Groups](https://docs.aureahub.com/docs/groups-list.md): GET /v1/groups. Your tenant's groups, by name, with how many members each has.
- [Create a Group](https://docs.aureahub.com/docs/group-create.md): POST /v1/groups. A new group of your tenant's users, empty: add its members next.
- [Get a Group](https://docs.aureahub.com/docs/group-get.md): GET /v1/groups/{groupId}. One group and its members.
- [Change a Group](https://docs.aureahub.com/docs/group-update.md): PATCH /v1/groups/{groupId}. Rename a group or change its description. Its id — what your rules name — stays.
- [Delete a Group](https://docs.aureahub.com/docs/group-delete.md): DELETE /v1/groups/{groupId}. The group and its memberships. A rule that names it then names no one by it.
- [Add a Member](https://docs.aureahub.com/docs/group-member-add.md): POST /v1/groups/{groupId}/members. One of your tenant's users joins the group.
- [Remove a Member](https://docs.aureahub.com/docs/group-member-remove.md): DELETE /v1/groups/{groupId}/members/{userId}. The user leaves the group; the account stays as it is.

## API Reference: Address Book

- [List Entries](https://docs.aureahub.com/docs/address-book-entries-list.md): GET /v1/address-book/entries. Your tenant's address book, newest first, filtered as you ask.
- [Add an Entry](https://docs.aureahub.com/docs/address-book-entry-add.md): POST /v1/address-book/entries. A new entry, cooling from its request: one of your wallets, someone else's address, or a contract.
- [Get an Entry](https://docs.aureahub.com/docs/address-book-entry-get.md): GET /v1/address-book/entries/{entryId}. One entry, with everything that happened to it.
- [Change an Entry](https://docs.aureahub.com/docs/address-book-entry-change.md): PATCH /v1/address-book/entries/{entryId}. Its label, tags and reference change at once. A new address cools again before it is a destination.
- [Remove an Entry](https://docs.aureahub.com/docs/address-book-entry-remove.md): DELETE /v1/address-book/entries/{entryId}. Removed at once, whatever its state: no operation can send to it any more.
- [Approve an Entry](https://docs.aureahub.com/docs/address-book-entry-approve.md): POST /v1/address-book/entries/{entryId}/approve. There is no approval step: this starts the cooling of an entry still pending, which is active when it ends.
- [Reject an Entry](https://docs.aureahub.com/docs/address-book-entry-reject.md): POST /v1/address-book/entries/{entryId}/reject. A pending entry is refused, a cooling one withdrawn — for good.
- [Ownership Challenge](https://docs.aureahub.com/docs/address-book-proof-challenge.md): POST /v1/address-book/entries/{entryId}/proof/challenge. The message an external address's owner signs to prove they hold it.
- [Prove Ownership](https://docs.aureahub.com/docs/address-book-proof-verify.md): POST /v1/address-book/entries/{entryId}/proof/verify. The owner's signature over one of the entry's challenges: the entry is proven.
- [Settings](https://docs.aureahub.com/docs/address-book-settings-get.md): GET /v1/address-book/settings. Your cooling period, whether external addresses are proven first, whether one-time addresses are allowed — and what your signing points do with the book.
- [Change the Settings](https://docs.aureahub.com/docs/address-book-settings-put.md): PUT /v1/address-book/settings. Raise a protection at once; lower one through an approval.
- [Setting Changes](https://docs.aureahub.com/docs/address-book-changes-list.md): GET /v1/address-book/settings/changes. Every change of the address book's settings asked for, newest first.
- [Approve a Change](https://docs.aureahub.com/docs/address-book-change-approve.md): POST /v1/address-book/settings/changes/{changeId}/approve. The change waiting for its approval is applied.
- [Reject a Change](https://docs.aureahub.com/docs/address-book-change-reject.md): POST /v1/address-book/settings/changes/{changeId}/reject. The change waiting for its approval is refused — or withdrawn, by who asked for it.

## API Reference: Quorum

- [List Requests](https://docs.aureahub.com/docs/quorum-requests-list.md): GET /v1/quorum/requests. Your administrators' covered actions — held for another administrator, or only recorded — newest first.
- [Get a Request](https://docs.aureahub.com/docs/quorum-request-get.md): GET /v1/quorum/requests/{id}. One request, with its decisions.
- [Approve](https://docs.aureahub.com/docs/quorum-request-approve.md): POST /v1/quorum/requests/{id}/approve. Another administrator's held action, approved with your password: it runs now.
- [Reject](https://docs.aureahub.com/docs/quorum-request-reject.md): POST /v1/quorum/requests/{id}/reject. Another administrator's held action, refused with your password: nothing runs.
- [Cancel](https://docs.aureahub.com/docs/quorum-request-cancel.md): POST /v1/quorum/requests/{id}/cancel. Take back an action you asked for, before anyone decides it.
- [Read the Answer](https://docs.aureahub.com/docs/quorum-request-result.md): POST /v1/quorum/requests/{id}/result. What your held action answered when it ran after its approval — once.

## API Reference: Aggregated Transactions

- [Unified Feed](https://docs.aureahub.com/docs/agg-tx-list.md): GET /v1/transactions/aggregated/. One paginated, date-sorted list of the user's blockchain transactions, bank ramp fiat activity and card purchases of crypto.

## API Reference: Notifications

- [Register Device](https://docs.aureahub.com/docs/notif-register.md): POST /v1/notifications/device-token. Register the device's push token (`pushToken`) so the user's device receives Aurea's push notifications. This is the way to register a device.
- [Unregister Device](https://docs.aureahub.com/docs/notif-unregister.md): DELETE /v1/notifications/device-token. Remove a device's push token so it stops receiving push notifications.
- [Get Inbox](https://docs.aureahub.com/docs/notif-inbox.md): GET /v1/notifications/inbox. Fetch the authenticated user's in-app notification inbox, newest first.
- [Unread Count](https://docs.aureahub.com/docs/notif-inbox-unread.md): GET /v1/notifications/inbox/unread-count. Return the count of unread notifications for the authenticated user.
- [Mark as Read](https://docs.aureahub.com/docs/notif-inbox-read.md): PATCH /v1/notifications/inbox/read. Mark one or more inbox notifications as read, or mark all at once.

## API Reference: DApps

- [List DApps](https://docs.aureahub.com/docs/dapps-list.md): GET /v1/dapps/. Retrieve the dApp catalogue configured for the authenticated user's tenant — the entries to show in an in-app dApp browser.
- [Get Nonce](https://docs.aureahub.com/docs/dapps-nonce.md): GET /v1/dapps/nonce. Get the next pending transaction nonce of an EVM address — used when building a transaction requested by a dApp.
- [Estimate Gas](https://docs.aureahub.com/docs/dapps-gas.md): GET /v1/dapps/estimate-gas. Estimate the gas limit of an EVM transaction on a given chain, with a 20% safety buffer applied.
- [Sign Personal Message](https://docs.aureahub.com/docs/dapps-sign.md): POST /v1/dapps/sign-personal-message. Handle a dApp's `personal_sign` (EIP-191) request. Custodial wallets are signed server-side; wallets without a server-held key get the digest back to sign on the client.
- [Broadcast Transaction](https://docs.aureahub.com/docs/dapps-broadcast.md): POST /v1/dapps/broadcast. Relay an already-signed raw EVM transaction to the RPC node of the given chain.

## API Reference: Portfolio

- [Portfolio Performance](https://docs.aureahub.com/docs/portfolio-perf.md): GET /v1/portfolio/performance. Daily EUR and USD totals of the user's portfolio over a period, with the change between the first and last day.

## API Reference: Swap Routes

- [List Routes](https://docs.aureahub.com/docs/swap-routes-list.md): GET /v1/swap/routes. Get the destination chains and tokens configured for a source token — use it to populate the "To" selector of a swap UI.