Aurea API Docs
This site is rendered with JavaScript. Every page is also available as Markdown: /llms.txt is the index and /llms-full.txt contains the complete documentation.
- Download OpenAPI (the live document) · Download the Postman collection
- Request sandbox access — we reply within one business day
- Aurea Pay (payment links and checkout) has its own documentation: pay.aureahub.com/docs
- Help: help@aureahub.com
Get Started
- Overview
- Environments & Test Data
- Credentials & Rotation
- Authentication
- Quickstart
- Feature Availability
- OpenAPI & Postman
- TypeScript SDK
Aurea Products
Concepts
- Amount Units
- Pagination
- Idempotency
- Errors & Codes
- Rate Limits
- Statuses
- Supported Chains
- Signing Primitives
- Versioning
- Changelog
Guides: Users & Wallets
- Users & Sign-In
- Two-Factor Sign-In
- Passkeys & Step-Up
- Wallets & Custody
- MPC Wallet Setup
- Embedded Wallet
- Prepare the Device in Advance
- Accounts
- Account Structures
Guides: Identity Verification
Guides: Payments
Guides: Ramps, Cards & Yield
- Bank Ramp: Setup & Customers
- Bank Ramp: Pay-In
- Bank Ramp: Payout
- Bank Ramp: Local Rails
- Bank Ramp: Desk Orders
- Card Onramp
- Cards & EUR Account
- Earn
- Lending
- Remittance
Guides: Tokenized Assets
Guides: Webhooks & Events
Security & Governance
- Server Credentials
- Policy Sets & Groups
- Approvals
- Your Tenant's Quorum
- Signing Rules
- Address Book
- Screening & AML Cases
- Freezes & Quarantines
- Institution Callback & Co-Signer
- Security Overview
- MPC Wallet Security
- Security & Data Residency
Agentic Payments
API Reference: Health
API Reference: Auth
- Register
- Login
- Refresh Token
- Google Sign-In
- Apple Sign-In
- Forgot Password
- Log Out
- Your Sessions
- End a Session
- Sign Out Elsewhere
API Reference: Two-Factor Sign-In
- Your Second Factor
- Enrol an App
- Confirm the App
- New Recovery Codes
- Remove the App
- Sign In: Second Step
- Reset a User's Factor
API Reference: Passkeys
- List Your Passkeys
- Registration Options
- Register a Passkey
- Revoke a Passkey
- Step-Up Options
- Step-Up
- Your Passkey Address
- Reset a User's Passkeys
API Reference: Your Tenant
- Get Your Tenant
- Get Public Config
- Available Features
- Enabled EVM Chains
- Your Tenant's Insights
- Search Your Tenant
API Reference: Credentials
- Get the API Key
- Rotate the API Key
- Get the API Secret
- Rotate the API Secret
- List Credentials
- Register a Credential
- Change a Credential
- Revoke a Credential
API Reference: Users
- Get My Profile
- Update My Profile
- List Users
- Create User
- Get User
- Update User
- Delete User
- Search Users
- Advanced Search
- Update fcm-token
- Generate QR Code
- List User Wallets
API Reference: Identity Verification
API Reference: Wallets
- Create Wallet
- List Wallets
- List Your Tenant's Wallets
- Import Wallet
- Get Wallet
- Delete Wallet
- Get Balance
- Aggregate Balances
- Set Primary Wallet
- Non-Custodial Challenge
- Register Client Wallet
- Confirm Client Custody
- Register Device Key
- Request Export Token
- Export Encrypted Key
- Migration Challenge
- Cancel Migration
- Set Primary (atomic)
API Reference: Accounts
- List Accounts
- Create an Account
- Get an Account
- Change an Account
- Add a Wallet
- Find by Address
- Create in Bulk
- List Bulk Creations
- Bulk Creation Report
API Reference: Account Structures
- List Structures
- Get a Structure
- Declare a Structure
- List Collection Accounts
- Add Collection Accounts
- Remove a Collection Account
- List Sweep Policies
- Set a Sweep Policy
- Remove a Sweep Policy
- Read the Sub-Ledger
- List Sub-Ledger Entries
- Read the Reconciliation
- List Transfers
- Get a Transfer
- Request a Pool Withdrawal
API Reference: MPC Wallets
- MPC Config
- Start DKG Ceremony
- Register MPC Wallet
- Start Aux Ceremony
- Start Signing Ceremony
- Prepare a Backup Proof
- Start a Backup Proof
- Complete a Backup Proof
- Get the Backup State
- List Wallet Setups
- Get a Wallet's Setup
- Report a Setup Step
- Restart a Pending Wallet
- Recovery Step-Up
- Service Token Bridge
- Relay: Join Session
- Relay: List Parties
- Relay: Post Message
- Relay: Read Inbox
- Relay: Get Message Hash
- Relay: Post Result
- Relay: Read Results
- Register a Recovery Key
- Get the Recovery Key
API Reference: Device Preparation
- Get the Preparation Settings
- Start a Preparation
- List Preparations
- Get a Preparation
- Delete a Preparation
API Reference: MPC Co-Signer
API Reference: Transactions
- Create Transaction
- Broadcast Transaction
- List Transactions
- Get Transaction
- Get Tx Status
- Transaction Quote
- Get Aggregated Tx
- Travel Rule Data
API Reference: Operations
- List Operations
- Count Operations
- Get an Operation
- Get by Your Own Id
- Get Its Approval
- Get Its Callback
- Cancel
- Get a Signing Check
API Reference: Gas Station
- Gas Station Settings
- List Policies
- Create a Policy
- Change a Policy
- List Funding Wallets
- Create a Funding Wallet
- List Top-Ups
- List Alarms
API Reference: Fees & Addresses
API Reference: Tokens
- List Tokens
- Tokens by Chain
- Supported Chains
- List Your Tokens
- Add a Token
- Change a Token
- Switch a Token On or Off
- Remove a Token
API Reference: Asset Registry
API Reference: Swap
- Get Quote
- Check Allowance
- Approve Token
- Execute Swap
- Simulate Swap
- Execute Gasless
- Broadcast Swap Tx
- Sign EIP-712 Permit
- Broadcast Approve Tx
- Broadcast Gasless Tx
- Execute Solana Swap
- Broadcast Solana Swap
API Reference: Bank Ramp: Pay-In
- Onboarding Status
- Onboarding Session
- Sync KYC Status
- Currencies & Networks
- What Your Tenant Offers
- Open a Virtual Account
- Payment Methods
- List Waiting Accounts
- Withdraw a Waiting Account
- Deposits
- Transactions
- Simulate Deposit
API Reference: Bank Ramp: Proven Addresses
API Reference: Bank Ramp: Customers
- Create a Customer
- Get the Customer
- Sync the Customer
- Send Details
- Send the Risk Form
- Send Verifications
- Share a KYC Applicant
- Upload a Document
- List Documents
- Start Hosted Onboarding
- Complete Hosted Onboarding
- Hosted Authorization
- Forget the Authorization
API Reference: Bank Ramp: Customer Addresses
- Link a Wallet
- Send a Link Signature
- List Wallet Links
- Ask for a Challenge
- Prove and Link an Address
- List Addresses
- Stop Using an Address
API Reference: Bank Ramp: Payout
- Countries
- Search Channels
- Channel Form
- Saved Beneficiaries
- Create a Quote
- Answer a Form Step
- Get a Quote
- Pay from a Wallet
- List Wallet Payouts
- Get a Wallet Payout
API Reference: Bank Ramp: Local Rails
- Your Verification
- Register
- Balances
- Banks & Mobile Money
- Ask How to Pay In
- List Instructions
- Get an Instruction
- Cancel an Instruction
- Sell a Stablecoin
- List Sales
- Get a Sale
- Say It Was Sent
- Cancel a Sale
- Stablecoin Deliveries
- Withdraw
- List Withdrawals
- Get a Withdrawal
API Reference: Bank Ramp: Desk
API Reference: Card Onramp
- Configuration
- Quotes
- Open a Session
- Get a Session
- List Sessions
- Hosted Page Link
- Hosted Page Read
- Address Challenge
- Verify an Address
- Proven Addresses
- Revoke an Address
API Reference: Card Onramp: Your Wallets
- Name an End User
- Get an End User
- Attest a Default Wallet
- Revoke a Default Wallet
- Open a Purchase
- List Purchases
- Get a Purchase
API Reference: Cards: Sign-In & Onboarding
- Local Status
- Sign-In Message
- Sign-In Nonce
- Sign In
- Sign Up
- End the Session
- Get the Account
- Terms
- Accept Terms
- Identity Check
- Source of Funds Questions
- Answer Source of Funds
- Send a Phone Code
- Check the Phone Code
- Smart Account
- Create the Smart Account
API Reference: Cards: EUR Account & Payouts
- IBAN Signing Message
- Activate the EUR Account
- Authorization Link
- Link Message
- Link the Address
- Payout Message
- Pay Out to a Bank
API Reference: Cards: Your Cards
API Reference: Earn
- Products
- Disclosure
- Accept a Disclosure
- Quote
- Deposit
- Withdraw
- Send Signatures
- List Operations
- Get an Operation
- Positions
API Reference: Lending
API Reference: Tokenized Assets: Catalogue
- List Assets
- Get an Asset
- Multipliers per Chain
- Supply
- Reserves
- Price Feeds
- Corporate-Action Calendar
- Corporate Actions
API Reference: Tokenized Assets: Market Data
- Market Status
- Latest Prices
- Tickers
- Paused & Limited Assets
- Asset Price
- Candles
- Market Data
- Latest Dividend
- Shares Multiplier
- Asset Status
API Reference: Tokenized Assets: Eligibility
API Reference: Tokenized Assets: Quotes & Orders
API Reference: Tokenized Assets: Operations
API Reference: Tokenized Assets: Yield Token
API Reference: Tokenized Assets: Secondary Market
API Reference: Your Webhooks
API Reference: Webhook Endpoints
- List Endpoints
- Add an Endpoint
- Change an Endpoint
- Endpoint: New Secret
- Endpoint: Send a Test
- Remove an Endpoint
- List Deliveries
- Attempts Log
- Send Again
- Client Certificate
API Reference: Audit Trail
API Reference: Reports
API Reference: Freezes & Quarantines
API Reference: AML Cases
API Reference: Policy Sets
- List Policy Sets
- Create a Draft
- Get a Policy Set
- Replace Rules
- Validate
- Simulate
- Submit
- Publish
- Withdraw
- Roll Back
API Reference: Approvals
API Reference: Institution Callback
API Reference: Groups
API Reference: Address Book
- List Entries
- Add an Entry
- Get an Entry
- Change an Entry
- Remove an Entry
- Approve an Entry
- Reject an Entry
- Ownership Challenge
- Prove Ownership
- Settings
- Change the Settings
- Setting Changes
- Approve a Change
- Reject a Change