Skip to content
Ele API

Overview

Ele API 1.0.0

Section titled “Ele API 1.0.0”

The Ele HTTP API. Every request is JSON over HTTPS and authenticates with a bearer token. Guides, conventions and limitations: https://developers.elephants.inc

Information

  • OpenAPI version: 3.1.1

Operations

Section titled “Operations”
POST
/api/v1/auth/login-credential
POST
/api/v1/auth/mfa
GET
/api/v1/auth/passkeys
POST
/api/v1/auth/passkeys/registration/complete
POST
/api/v1/auth/passkeys/registration/start
DELETE
/api/v1/auth/passkeys/{credential_id}
POST
/api/v1/auth/password-reset/complete
POST
/api/v1/auth/password-reset/request
POST
/api/v1/auth/sign-in
POST
/api/v1/auth/sign-in/device
POST
/api/v1/auth/sign-in/passkey/complete
POST
/api/v1/auth/sign-in/passkey/start
POST
/api/v1/auth/sign-in/totp/activate
POST
/api/v1/auth/sign-in/totp/setup
POST
/api/v1/auth/sign-out
POST
/api/v1/auth/step-up/complete
POST
/api/v1/auth/step-up/exit
POST
/api/v1/auth/step-up/fallback
GET
/api/v1/auth/step-up/{sudo_session_id}
POST
/api/v1/auth/totp/activate
POST
/api/v1/auth/totp/remove
POST
/api/v1/auth/totp/setup
POST
/api/v1/signup/complete
POST
/api/v1/signup/email
POST
/api/v1/signup/verify
GET
/api/v1/me
PATCH
/api/v1/me
POST
/api/v1/me/avatar
POST
/api/v1/me/emails
POST
/api/v1/me/emails/confirm
POST
/api/v1/me/phones
POST
/api/v1/me/phones/confirm
PUT
/api/v1/me/primary-email
POST
/api/v1/me/terms-acceptance
GET
/api/v1/me/preferences
PATCH
/api/v1/me/preferences
GET
/api/v1/organizations/{organization_id}/preferences
PATCH
/api/v1/organizations/{organization_id}/preferences
GET
/api/v1/devices
DELETE
/api/v1/devices/{device_id}
PUT
/api/v1/me/primary-organization
GET
/api/v1/organizations
POST
/api/v1/organizations
GET
/api/v1/organizations/{organization_id}
PATCH
/api/v1/organizations/{organization_id}
GET
/api/v1/organizations/{organization_id}/balance
GET
/api/v1/organizations/{organization_id}/balance/valuation
GET
/api/v1/organizations/{organization_id}/capabilities
POST
/api/v1/organizations/{organization_id}/logo
GET
/api/v1/organizations/{organization_id}/members
DELETE
/api/v1/organizations/{organization_id}/members/{member_id}
PATCH
/api/v1/organizations/{organization_id}/members/{member_id}
POST
/api/v1/invitations/accept
POST
/api/v1/invitations/validate
GET
/api/v1/invitations/{invitation_id}
DELETE
/api/v1/invitations/{invitation_id}
POST
/api/v1/invitations/{invitation_id}/resend
GET
/api/v1/organizations/{organization_id}/invitations
POST
/api/v1/organizations/{organization_id}/invitations
POST
/api/v1/organizations/{organization_id}/invitations/bulk
GET
/api/v1/me/capabilities
GET
/api/v1/onboarding/document-catalog
POST
/api/v1/onboarding/initial-user-details
GET
/api/v1/onboarding/questionnaire-options/business
GET
/api/v1/onboarding/questionnaire-options/personal
POST
/api/v1/onboarding/requirements/submissions
GET
/api/v1/organizations/{organization_id}/onboarding/checklist
GET
/api/v1/organizations/{organization_id}/onboarding/profile-gaps
POST
/api/v1/organizations/{organization_id}/onboarding/profile-gaps/submissions
GET
/api/v1/organizations/{organization_id}/onboarding/subscription-acknowledgement
POST
/api/v1/organizations/{organization_id}/onboarding/subscription-acknowledgement
POST
/api/v1/organizations/{organization_id}/kyb/access-token
POST
/api/v1/organizations/{organization_id}/kyb/business-activity
POST
/api/v1/organizations/{organization_id}/kyb/business-details
GET
/api/v1/organizations/{organization_id}/kyb/business-profile
POST
/api/v1/organizations/{organization_id}/kyb/revenue-funds
POST
/api/v1/kyc/access-token
POST
/api/v1/organizations/{organization_id}/kyc/questionnaire
POST
/api/v1/documents
POST
/api/v1/organizations/{organization_id}/files
GET
/api/v1/countries
GET
/api/v1/countries/signup-eligible
GET
/api/v1/countries/{country_code}/subdivisions
GET
/api/v1/organizations/{organization_id}/currencies
GET
/api/v1/organizations/{organization_id}/multi-currency-accounts
POST
/api/v1/organizations/{organization_id}/multi-currency-accounts
GET
/api/v1/organizations/{organization_id}/fiat-deposit-accounts
GET
/api/v1/organizations/{organization_id}/fiat-deposit-accounts/by-currency
GET
/api/v1/organizations/{organization_id}/billing-contacts/{billing_contact_id}/deposit-addresses
GET
/api/v1/organizations/{organization_id}/deposit-addresses
POST
/api/v1/deposits/{deposit_id}/sender-travel-rule
GET
/api/v1/organizations/{organization_id}/virtual-accounts
GET
/api/v1/organizations/{organization_id}/transactions
GET
/api/v1/transactions/{transaction_id}
GET
/api/v1/exports/{export_id}
POST
/api/v1/organizations/{organization_id}/exports
PATCH
/api/v1/crypto-destinations/{crypto_destination_id}/travel-rule
GET
/api/v1/organizations/{organization_id}/payment-contacts
POST
/api/v1/organizations/{organization_id}/payment-contacts
GET
/api/v1/organizations/{organization_id}/payments/summary
GET
/api/v1/payment-contacts/{contact_id}
DELETE
/api/v1/payment-contacts/{contact_id}
PATCH
/api/v1/payment-contacts/{contact_id}
PUT
/api/v1/payment-contacts/{contact_id}/destination
PATCH
/api/v1/payment-contacts/{contact_id}/destination
POST
/api/v1/payments
GET
/api/v1/payments/config
GET
/api/v1/payments/destination-requirements
POST
/api/v1/payments/execute
POST
/api/v1/payments/preflight
GET
/api/v1/payments/{payment_id}
POST
/api/v1/payments/{payment_id}/cancel
POST
/api/v1/payments/{payment_id}/requote
GET
/api/v1/organizations/{organization_id}/payment-batches
POST
/api/v1/organizations/{organization_id}/payment-batches
GET
/api/v1/payment-batches/template
GET
/api/v1/payment-batches/{batch_id}
DELETE
/api/v1/payment-batches/{batch_id}
PATCH
/api/v1/payment-batches/{batch_id}
POST
/api/v1/payment-batches/{batch_id}/cancel
POST
/api/v1/payment-batches/{batch_id}/import
POST
/api/v1/payment-batches/{batch_id}/requote
POST
/api/v1/payment-batches/{batch_id}/review
POST
/api/v1/payment-batches/{batch_id}/rows
DELETE
/api/v1/payment-batches/{batch_id}/rows/{row_id}
PATCH
/api/v1/payment-batches/{batch_id}/rows/{row_id}
POST
/api/v1/payment-batches/{batch_id}/submit
POST
/api/v1/payment-batches/{batch_id}/upload
POST
/api/v1/payment-batches/{batch_id}/validate
GET
/api/v1/approvals/{approval_id}
POST
/api/v1/approvals/{approval_id}/approve
POST
/api/v1/approvals/{approval_id}/cancel
POST
/api/v1/approvals/{approval_id}/reject
GET
/api/v1/organizations/{organization_id}/approvals
POST
/api/v1/me/approval-credential
GET
/api/v1/me/challenges
GET
/api/v1/me/challenges/{challenge_id}
POST
/api/v1/me/challenges/{challenge_id}/approve
POST
/api/v1/me/challenges/{challenge_id}/decline
POST
/api/v1/me/challenges/{challenge_id}/webauthn_options
GET
/api/v1/quotes/{quote_id}
GET
/api/v1/conversions/quote
POST
/api/v1/swaps/execute
POST
/api/v1/swaps/preflight
GET
/api/v1/swaps/{swap_id}
GET
/api/v1/organizations/{organization_id}/billing-contacts/{billing_contact_id}/allocations
GET
/api/v1/organizations/{organization_id}/invoices
POST
/api/v1/organizations/{organization_id}/invoices
GET
/api/v1/organizations/{organization_id}/invoices/aggregates
GET
/api/v1/organizations/{organization_id}/invoices/summary
GET
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}
DELETE
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}
PATCH
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}
POST
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}/allocate
POST
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}/deallocate
POST
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}/resend-email
POST
/api/v1/organizations/{organization_id}/invoices/{billing_invoice_id}/submit
GET
/api/v1/bills/{bill_id}
PATCH
/api/v1/bills/{bill_id}
POST
/api/v1/bills/{bill_id}/cancel
GET
/api/v1/organizations/{organization_id}/bills
POST
/api/v1/organizations/{organization_id}/bills
POST
/api/v1/organizations/{organization_id}/bills/upload
GET
/api/v1/expenses/{expense_id}
DELETE
/api/v1/expenses/{expense_id}
PATCH
/api/v1/expenses/{expense_id}
POST
/api/v1/expenses/{expense_id}/bindings
DELETE
/api/v1/expenses/{expense_id}/bindings/{binding_id}
POST
/api/v1/expenses/{expense_id}/receipts
DELETE
/api/v1/expenses/{expense_id}/receipts/{receipt_id}
GET
/api/v1/organizations/{organization_id}/expenses
POST
/api/v1/organizations/{organization_id}/expenses
GET
/api/v1/organizations/{organization_id}/billing-contacts
POST
/api/v1/organizations/{organization_id}/billing-contacts
DELETE
/api/v1/organizations/{organization_id}/billing-contacts/{billing_contact_id}
PATCH
/api/v1/organizations/{organization_id}/billing-contacts/{billing_contact_id}
POST
/api/v1/cards
GET
/api/v1/cards/{card_id}
PATCH
/api/v1/cards/{card_id}
POST
/api/v1/cards/{card_id}/activate
GET
/api/v1/cards/{card_id}/details
POST
/api/v1/cards/{card_id}/freeze
POST
/api/v1/cards/{card_id}/google-wallet-provision
GET
/api/v1/cards/{card_id}/physical-order
POST
/api/v1/cards/{card_id}/physical-order
GET
/api/v1/cards/{card_id}/physical-order/options
POST
/api/v1/cards/{card_id}/pin
POST
/api/v1/cards/{card_id}/unfreeze
GET
/api/v1/organizations/{organization_id}/cards
GET
/api/v1/organizations/{organization_id}/physical-card/offers
GET
/api/v1/organizations/{organization_id}/card-entitlements
POST
/api/v1/organizations/{organization_id}/card-entitlements
POST
/api/v1/three-ds/confirm
POST
/api/v1/three-ds/review
GET
/api/v1/organizations/{organization_id}/integrations
POST
/api/v1/organizations/{organization_id}/integrations/shopify/authorize-url
GET
/api/v1/organizations/{organization_id}/integrations/sync-summary
GET
/api/v1/organizations/{organization_id}/integrations/xero
PATCH
/api/v1/organizations/{organization_id}/integrations/xero
GET
/api/v1/organizations/{organization_id}/integrations/xero/accounts
POST
/api/v1/organizations/{organization_id}/integrations/xero/authorize-url
GET
/api/v1/organizations/{organization_id}/integrations/xero/mapping-options
GET
/api/v1/organizations/{organization_id}/integrations/xero/mappings
POST
/api/v1/organizations/{organization_id}/integrations/xero/setup
POST
/api/v1/organizations/{organization_id}/integrations/xero/suggested-mappings
DELETE
/api/v1/organizations/{organization_id}/integrations/{service}
GET
/api/v1/organizations/{organization_id}/subscription
GET
/api/v1/organizations/{organization_id}/subscription/active
GET
/api/v1/organizations/{organization_id}/subscription/offers
GET
/api/v1/organizations/{organization_id}/subscription/quote
POST
/api/v1/organizations/{organization_id}/subscription/select-plan
POST
/api/v1/subscriptions/{subscription_id}/cancel-scheduled-update
GET
/api/v1/organizations/{organization_id}/purchases
GET
/api/v1/purchases/{purchase_id}/receipt
GET
/api/v1/organizations/{organization_id}/points/balance
GET
/api/v1/organizations/{organization_id}/points/breakdown
GET
/api/v1/organizations/{organization_id}/points/cap-usage
GET
/api/v1/organizations/{organization_id}/points/offers
POST
/api/v1/organizations/{organization_id}/points/select-plan
GET
/api/v1/points/rate-catalog
POST
/api/v1/organizations/{organization_id}/rewards/redeem
GET
/api/v1/rewards/catalog
GET
/api/v1/organizations/{organization_id}/attention
GET
/api/v1/organizations/{organization_id}/attention/summary
GET
/api/v1/organizations/{organization_id}/attention/{item_id}
GET
/api/v1/organizations/{organization_id}/insights
GET
/api/v1/ele-ids/{ele_id}
DELETE
/api/v1/api-keys/{api_key_id}
PATCH
/api/v1/api-keys/{api_key_id}
POST
/api/v1/api-keys/{api_key_id}/rotate
GET
/api/v1/organizations/{organization_id}/api-keys
POST
/api/v1/organizations/{organization_id}/api-keys

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

An Ele session token, or an organization API key (ele_<env>_<lookup>_<secret>). API keys are limited by role and scope and cannot complete step-up; see https://developers.elephants.inc/concepts/api-keys/.

Security scheme type: http

Bearer format: session JWT or API key