Skip to content
Ele API
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Get started
Overview
Environments
Quickstart
Example code
Core concepts
Authentication
Step-up and approvals
Organizations and roles
Errors
Idempotency
Pagination
Money
Rate limits
Versioning
Staying in sync
API keys
Guides
Onboarding
Accounts and balances
Paying out
Batch payments
Swaps
Invoices, bills and expenses
Cards
Go client
Current limitations
API reference
Overview
Auth
Issue a device login credential
Complete login MFA
List passkeys
Complete passkey registration
Start passkey registration
Remove a passkey
Complete a password reset
Request a password reset
Sign in with a password
Sign in with a device login credential
Complete passkey sign-in
Start discoverable passkey sign-in
Activate TOTP during sign-in
Set up TOTP during sign-in
Sign out
Complete a step-up challenge
Exit step-up mode
Request the step-up fallback
Get a step-up challenge's status
Activate TOTP
Remove TOTP
Set up TOTP
Signup
Complete email-first signup
Start email-first signup
Verify a signup email
Me
Get the current user's identity and context
Update the current user's profile
Upload the current user's avatar
Add an email address
Confirm an email address
Add a phone number
Confirm a phone number
Set the primary email address
Accept the current terms
Preferences
List user preferences
Update user preferences
List organization preferences
Update organization preferences
Devices
List active devices
Remove a device
Organizations
Set the primary organization
List the organizations you belong to
Create an organization
Get an organization
Update an organization
Get balances for all accessible organizations
Estimate the total value of an organization's balances
Get organization capability rollup
Upload an organization logo
Members
List organization members
Remove organization member
Update organization member
Invitations
Accept an invitation
Validate an invitation token
Get an invitation
Delete an invitation
Resend an invitation
List organization invitations
Create an organization invitation
Create organization invitations
Onboarding
Get the viewer's personal verification and checklist
Get onboarding document requirements
Submit the batched initial user details
Get business onboarding questionnaire options
Get personal onboarding questionnaire options
Submit an onboarding requirement
Get an organization's member-readable onboarding checklist
Get an organization's outstanding profile gaps
Submit an organization's profile gap
Get an organization's subscription acknowledgement state
Acknowledge the organization's subscription plan
KYB
Create a business KYB WebSDK token
Submit KYB business activity
Submit KYB business details
Get the submitted KYB business profile
Submit KYB revenue and funds
KYC
Create a personal KYC WebSDK token
Submit the personal KYC questionnaire
Documents
Upload a document
Files
Create a file for direct upload
Countries
List countries with subdivision metadata
List countries eligible for signup
List a country's subdivisions
Currencies
List currencies available to an organization
Multi-Currency Accounts
List currency account states
Request currency accounts
Deposit Accounts
List fiat deposit accounts
List fiat deposit accounts by currency
Deposit Addresses
List a billing contact's crypto deposit addresses
List crypto deposit addresses
Deposits
Submit deposit sender travel-rule information
Virtual Accounts
List virtual accounts
Transactions
List transactions
Get a transaction
Exports
Get an export
Create an export
Payments
Update a specific crypto destination's travel-rule information
List payment contacts
Create payment contact
Get payments summary
Get payment contact
Delete payment contact
Update payment contact
Set payment contact destination
Update payment contact destination
Create a payment
Get payment metadata
Get payment destination requirements
Execute payment
Create payment quote
Get a payment
Cancel a payment
Requote a payment
Payment batches
List payment batches
Create a payment batch
Get the CSV upload template for a payout currency
Get a payment batch
Delete a draft payment batch
Update a draft payment batch
Cancel an awaiting-approval batch
Import an uploaded sheet into a draft payment batch
Refresh a batch's lapsed quotes
Price every row of a draft batch
Add rows to a draft payment batch
Remove a row from a draft payment batch
Update a row of a draft payment batch
Submit a reviewed batch for approval
Open a file slot for a batch's upload sheet
Validate a draft payment batch's rows
Approvals
Get an approval request
Approve a request
Cancel an approval request
Reject a request
List approval requests
Challenges
Enroll the device approval credential
List pending assurance challenges
Get an assurance challenge
Approve an assurance challenge
Decline an assurance challenge
Mint WebAuthn options for approving a challenge
Quotes
Get a payment quote
Conversions
Get an indicative conversion quote
Swaps
Execute a fiat swap
Create a fiat swap quote
Get a fiat swap
Invoices
List billing allocations
List billing invoices
Create a billing invoice
Get invoice aggregates
Get billing summary
Get a billing invoice
Delete a billing invoice
Update a billing invoice
Allocate credit to an invoice
Reverse an invoice allocation
Resend an invoice email
Submit an invoice for approval
Bills
Get a bill
Update a bill
Cancel a bill
List bills
Create a bill
Upload an invoice and create a bill
Expenses
Get an expense
Delete an expense
Update an expense
Bind a transaction to an expense
Unbind a transaction from an expense
Attach a receipt to an expense
Remove a receipt from an expense
List expenses
Create an expense
Billing Contacts
List billing contacts
Create a billing contact
Delete a billing contact
Update a billing contact
Cards
Create a card
Get a card
Update a card
Activate a card
Get card details
Freeze a card
Provision a card for Google Wallet
Get a physical card order
Order a physical card
List physical card options
Set a card PIN
Unfreeze a card
List cards
List physical card offers
Card Entitlements
List card entitlements
Create a card entitlement
ThreeDS
Confirm a 3DS challenge
Review a 3DS challenge
Integrations
List integration connections
Start connecting Shopify
Get integration sync summary
Get Xero setup
Update Xero settings
List Xero accounts
Start connecting Xero
Get Xero mapping options
List Xero account mappings
Save Xero setup
Suggest Xero account mappings
Disconnect an integration
Subscriptions
Get subscription summary
Get active subscription
List subscription offers
Quote a subscription change
Select a subscription plan
Cancel a scheduled subscription change
Purchases
List purchases
Get a purchase receipt
Points
Get points balance
Get points balance breakdown
Get the monthly points allowance
List point-adjustment offers
Select a point-adjustment plan
Get the cross-plan points rate catalogue
Rewards
Submit a rewards redemption request
List the personalized rewards catalog
Attention
List attention items
Get attention counts
Get an attention item
Insights
Get financial insights
EleIds
Get an Ele ID's public card
API keys
Revoke an API key
Update an API key
Rotate an API key
List API keys
Create an API key
Changelog
Select theme
Dark
Light
Auto
Changelog
2026-10-09
Section titled “2026-10-09”
First public release of the Ele API documentation.