# Orenda API

> One API for onboarding, accounts, cards, payments, and compliance.

## Get started

- [Orenda API](https://api-docs.orenda-apps.com/introduction): One API for onboarding, accounts, cards, payments, and compliance.
- [Apply for API access](https://api-docs.orenda-apps.com/contact): Tell us about your business and the API access you need, and our team will be in touch.
- [Roles & access](https://api-docs.orenda-apps.com/roles-and-access): Guardians and the roles that decide who can do what.
- [Program capabilities](https://api-docs.orenda-apps.com/capabilities): What your program can do, and how to find out — without caring how it's powered.
- [Issuing a card, end-to-end](https://api-docs.orenda-apps.com/guides/issue-cards): From a program-provisioned user to a funded, ordered card — the Customer API steps.

## Authentication

- [Authentication overview](https://api-docs.orenda-apps.com/auth/overview): How login works, and how to use your tokens.

## Register

- [Sign up](https://api-docs.orenda-apps.com/auth/register/sign-up): Create a new user.
- [Confirm sign-up](https://api-docs.orenda-apps.com/auth/register/confirm): Confirm a new user with the code we emailed them.
- [Resend code](https://api-docs.orenda-apps.com/auth/register/resend): Resend the sign-up confirmation code.

## Security setup

- [Complete security setup](https://api-docs.orenda-apps.com/auth/security-setup/overview): What to do after you get a SECURITY_SETUP_REQUIRED challenge.
- [Set up a passkey (start)](https://api-docs.orenda-apps.com/auth/security-setup/passkey-start): Begin passkey registration during security setup.
- [Set up a passkey (finish)](https://api-docs.orenda-apps.com/auth/security-setup/passkey-finish): Store the passkey the device created.
- [Set up 2FA (start)](https://api-docs.orenda-apps.com/auth/security-setup/mfa-setup): Get a secret and QR code during security setup.
- [Set up 2FA (confirm)](https://api-docs.orenda-apps.com/auth/security-setup/mfa-confirm): Turn on 2FA with the first code from the app.
- [Finish security setup](https://api-docs.orenda-apps.com/auth/security-setup/complete): Exchange the session token for tokens.

## Passkey sign-in (recommended)

- [Passkey sign-in (start)](https://api-docs.orenda-apps.com/auth/passkey-login/start): Begin a passkey sign-in: get the challenge and unlock on the device.
- [Passkey sign-in (finish)](https://api-docs.orenda-apps.com/auth/passkey-login/finish): Send the device's assertion and receive the tokens.

## Password sign-in

- [Log in](https://api-docs.orenda-apps.com/auth/login): Start a login and handle the challenge you get back.
- [Verify email after login](https://api-docs.orenda-apps.com/auth/email-verify): Confirm the emailed code a password login asks for.
- [Complete 2FA](https://api-docs.orenda-apps.com/auth/two-factor): Finish a login that asked for a 2FA code.
- [Start 2FA setup](https://api-docs.orenda-apps.com/auth/set-up-2fa/start): Get a secret and QR code for an authenticator app.
- [Confirm 2FA setup](https://api-docs.orenda-apps.com/auth/set-up-2fa/confirm): Turn on 2FA with the first code from the app.
- [Request a reset](https://api-docs.orenda-apps.com/auth/password-reset/request): Email the user a password reset code.
- [Set a new password](https://api-docs.orenda-apps.com/auth/password-reset/set-new): Use the reset code to set a new password.
- [Change a temporary password](https://api-docs.orenda-apps.com/auth/change-password): Swap a temporary password for a real one.

## Sessions

- [Refresh tokens](https://api-docs.orenda-apps.com/auth/sessions/refresh): Get a new access token without logging in again.
- [Log out](https://api-docs.orenda-apps.com/auth/sessions/logout): End the session and revoke the access token.

## Onboarding

- [Onboarding overview](https://api-docs.orenda-apps.com/onboarding/overview): Create an application, then poll its status and render each step.
- [Invite a sub-user](https://api-docs.orenda-apps.com/onboarding/invite-sub-user): Invite a sub-role member (prepaid-card, child, spouse, or card-only) funded from your account.
- [Create an application](https://api-docs.orenda-apps.com/onboarding/create): Start onboarding for the signed-in user.
- [Get the current application](https://api-docs.orenda-apps.com/onboarding/status): Poll the application and render its current step.
- [Get the KYC form schema](https://api-docs.orenda-apps.com/onboarding/kyc-schema): Fetch the form to render for the current KYC/KYB step.
- [Submit KYC data](https://api-docs.orenda-apps.com/onboarding/kyc-submit): Send the answers for a KYC/KYB step.
- [Upload a KYC document](https://api-docs.orenda-apps.com/onboarding/kyc-documents): Send a verification document against the application.
- [Document presign URL](https://api-docs.orenda-apps.com/onboarding/document-presign): Upload or download verification documents via short-lived URLs.
- [Submit KYC answers](https://api-docs.orenda-apps.com/onboarding/kyc-questions): The customer's questionnaire answers, shaped by the KYC schema.
- [Submit KYB data](https://api-docs.orenda-apps.com/onboarding/kyb-submit): Send the answers for a company (KYB) step.
- [UBO actions](https://api-docs.orenda-apps.com/onboarding/ubo-actions): Send verification emails to UBOs, or reset their verification.
- [Verification status](https://api-docs.orenda-apps.com/onboarding/verification-status): Per-step review status for the application (and its UBOs).
- [Get a Sumsub SDK token](https://api-docs.orenda-apps.com/onboarding/sumsub-token): Get a token to run the Sumsub identity check.
- [Accept legal agreements](https://api-docs.orenda-apps.com/onboarding/accept-legals): Accept the program's terms to finish onboarding.

## Accounts

- [Accounts overview](https://api-docs.orenda-apps.com/accounts/overview): The customer's bank accounts: balances, bank details, limits, and status.
- [List accounts](https://api-docs.orenda-apps.com/accounts/list): The customer's accounts, with balances and bank details.
- [Open an additional account](https://api-docs.orenda-apps.com/accounts/create): Queue a new account in another currency.
- [Get account limits](https://api-docs.orenda-apps.com/accounts/limits): Transaction limits and how much of them is used.
- [Update account limits](https://api-docs.orenda-apps.com/accounts/update-limits): Set single, daily, and monthly transaction limits.
- [Block an account](https://api-docs.orenda-apps.com/accounts/block): Stop payments and block linked cards.
- [Unblock an account](https://api-docs.orenda-apps.com/accounts/unblock): Reactivate a blocked account and its cards.
- [Close an account](https://api-docs.orenda-apps.com/accounts/close): Permanently close an account.
- [Account confirmation letter](https://api-docs.orenda-apps.com/accounts/confirmation-letter): Generate a proof-of-account PDF.

## Beneficiaries

- [Beneficiaries overview](https://api-docs.orenda-apps.com/beneficiaries/overview): The payees a customer can send money to.
- [Verify a payee](https://api-docs.orenda-apps.com/beneficiaries/verify-payee): Check a name matches the account before you pay.
- [Add a beneficiary](https://api-docs.orenda-apps.com/beneficiaries/create): Create a payee, confirmed with a passkey, 2FA code, or PIN.
- [Confirm with a passkey](https://api-docs.orenda-apps.com/beneficiaries/confirm-passkey): Get a step-up passkey challenge before adding a beneficiary.
- [Request a security PIN](https://api-docs.orenda-apps.com/beneficiaries/request-pin): Send the customer a one-time PIN by SMS for step-up confirmation.
- [International beneficiary](https://api-docs.orenda-apps.com/beneficiaries/international): Add a payee for cross-border (FX) payments.

## Manage

- [List beneficiaries](https://api-docs.orenda-apps.com/beneficiaries/manage/list): List a customer's saved payees.
- [Get a beneficiary](https://api-docs.orenda-apps.com/beneficiaries/manage/get): Fetch a single saved payee.
- [Delete a beneficiary](https://api-docs.orenda-apps.com/beneficiaries/manage/delete): Remove a saved payee.

## Cards

- [Cards overview](https://api-docs.orenda-apps.com/cards/overview): Issue and manage cards on an account.
- [Get card options](https://api-docs.orenda-apps.com/cards/card-options): The card products you can create on this account.
- [Create a card](https://api-docs.orenda-apps.com/cards/create-card): Issue a new card on an account.
- [Get cards](https://api-docs.orenda-apps.com/cards/get-cards): List the cards on an account.
- [Get card details](https://api-docs.orenda-apps.com/cards/get-card): Fetch a single card.
- [Activate a card](https://api-docs.orenda-apps.com/cards/activate): Turn a newly issued card on.
- [Block a card](https://api-docs.orenda-apps.com/cards/block): Temporarily stop a card.
- [Unblock a card](https://api-docs.orenda-apps.com/cards/unblock): Reinstate a blocked card.
- [Cancel a card](https://api-docs.orenda-apps.com/cards/cancel): Permanently close a card.
- [Reset card PIN](https://api-docs.orenda-apps.com/cards/reset-pin): Set a new PIN for a card.
- [Update card limit group](https://api-docs.orenda-apps.com/cards/update-limit-group): Change a card's spending limits.
- [Load / unload card balance](https://api-docs.orenda-apps.com/cards/load-unload-balance): Move money between the account and the card.
- [List card transactions](https://api-docs.orenda-apps.com/cards/card-transactions): Spend on a specific card, with merchant details.
- [Get secure key](https://api-docs.orenda-apps.com/cards/secure-key): Start the secure card details handshake.
- [Get secure card details](https://api-docs.orenda-apps.com/cards/secure-details): Show the full PAN, CVV, and expiry behind a step-up confirmation.
- [Confirm 3DS](https://api-docs.orenda-apps.com/cards/confirm-3ds): Approve or reject a 3D Secure challenge.

## Cardholders

- [Cardholders](https://api-docs.orenda-apps.com/cards/cardholders): Let someone hold a card on an account they don't own.
- [Create a cardholder](https://api-docs.orenda-apps.com/cards/create-cardholder): Add a person who can hold cards on this account.
- [Invite a cardholder](https://api-docs.orenda-apps.com/cards/invite-cardholder): Link an invited customer to a specific card.
- [List card invites](https://api-docs.orenda-apps.com/cards/list-card-invites): The cardholder invites you've sent, with statuses.
- [Revoke a card invite](https://api-docs.orenda-apps.com/cards/revoke-card-invite): Withdraw a cardholder invite.
- [Confirm a holder authentication](https://api-docs.orenda-apps.com/cards/confirm-holder-auth): Accept or cancel a pending cardholder challenge.

## Payments

- [Payments overview](https://api-docs.orenda-apps.com/payments/overview): Send money from an account to a payee.
- [Make a payment](https://api-docs.orenda-apps.com/payments/create-payment): Send a normal or scheduled payment.
- [List payment requests](https://api-docs.orenda-apps.com/payments/payment-requests): The in-flight state of initiated payments.
- [International transfer](https://api-docs.orenda-apps.com/payments/international-transfer): Send money abroad, with an extra check for new payees.
- [Get an FX quote](https://api-docs.orenda-apps.com/payments/fx-quote): Get a rate before sending money abroad.
- [Supported currencies](https://api-docs.orenda-apps.com/payments/supported-currencies): See which currencies your program can use.
- [Work out a fee](https://api-docs.orenda-apps.com/payments/calculate-fee): Check the fee before you send a payment.

## Scheduled payments

- [List scheduled payments](https://api-docs.orenda-apps.com/payments/scheduled/list): List a customer's scheduled payments.
- [Cancel a scheduled payment](https://api-docs.orenda-apps.com/payments/scheduled/delete): Cancel a scheduled payment and stop it repeating.

## Batch payments

- [Batch payments overview](https://api-docs.orenda-apps.com/payments/batch/overview): Send many payments at once: verify, initiate, then submit.
- [Verify a batch](https://api-docs.orenda-apps.com/payments/batch/verify): Submit the items for validation and a payee name check.
- [Check verify status](https://api-docs.orenda-apps.com/payments/batch/check-status): Poll until the batch validation finishes.
- [Initiate a batch](https://api-docs.orenda-apps.com/payments/batch/initiate): Get the total and an authentication challenge.
- [Submit a batch](https://api-docs.orenda-apps.com/payments/batch/submit): Authorise and send the batch with SCA.
- [Track a batch](https://api-docs.orenda-apps.com/payments/batch/track): Watch each payment in the batch complete.

## Transactions

- [Transactions overview](https://api-docs.orenda-apps.com/transactions/overview): Transaction history, filtering, and statements.
- [List transactions](https://api-docs.orenda-apps.com/transactions/list): The customer's transaction history, filterable.
- [Generate a statement](https://api-docs.orenda-apps.com/transactions/statement): A PDF or CSV account statement for a chosen period.

## Fees & limits

- [Customer fees](https://api-docs.orenda-apps.com/fees/customer-fees): The fee schedule that applies to the customer.
- [Customer limits](https://api-docs.orenda-apps.com/fees/customer-limits): The published payment, card, ATM, and balance limits.

## Real-time

- [Real-time (WebSockets)](https://api-docs.orenda-apps.com/websockets/overview): A persistent connection for server-pushed events — no polling.
- [3DS events](https://api-docs.orenda-apps.com/websockets/three-ds): Receive 3D Secure challenges in real time and acknowledge them.

## API reference

- `POST /v1/auth/login`: Log in
- `POST /v1/auth/verify-2fa`: Complete 2FA
- `POST /v1/auth/refresh`: Refresh tokens
- `POST /v1/auth/logout`: Log out
- `POST /v1/auth/register`: Register
- `POST /v1/auth/register/confirm`: Confirm registration
- `POST /v1/auth/register/resend-confirmation`: Resend confirmation code
- `POST /v1/auth/forgot-password`: Start a password reset
- `POST /v1/auth/forgot-password/confirm`: Finish a password reset
- `POST /v1/auth/change-password`: Change a temporary password
- `POST /v1/auth/mfa/setup`: Start 2FA setup
- `POST /v1/auth/mfa/confirm`: Confirm 2FA setup
- `POST /v1/auth/passkey/register/start`: Start adding a passkey
- `POST /v1/auth/passkey/register/complete`: Finish adding a passkey
- `POST /v1/auth/passkey/login`: Start a passkey login
- `POST /v1/auth/passkey/verify`: Finish a passkey login
- `POST /v1/auth/passkey/challenge`: Step-up passkey challenge
- `GET /v1/auth/passkey/credentials`: List passkeys
- `PATCH /v1/auth/passkey/credentials/{id}`: Rename a passkey
- `DELETE /v1/auth/passkey/credentials/{id}`: Delete a passkey
- `POST /v1/auth/security-setup/mfa/setup`: Set up 2FA (start)
- `POST /v1/auth/security-setup/mfa/confirm`: Set up 2FA (confirm)
- `POST /v1/auth/security-setup/passkey/register/start`: Set up a passkey (start)
- `POST /v1/auth/security-setup/passkey/register/complete`: Set up a passkey (finish)
- `POST /v1/auth/security-setup/email/verify/confirm`: Confirm email during security setup
- `POST /v1/auth/security-setup/complete`: Finish security setup
- `GET /v1/applications`: Get the current application
- `POST /v1/applications`: Create an application
- `GET /v1/applications/{applicationId}/kyc/schema`: Get the KYC form schema
- `POST /v1/applications/{applicationId}/kyc`: Submit KYC data
- `POST /v1/applications/kyb`: Submit KYB data
- `GET /v1/applications/{applicationId}/webtoken/sumsub`: Get a Sumsub SDK token
- `GET /v1/applications/{applicationId}/documents/legal`: Get legal documents
- `GET /v1/applications/{applicationId}/agreements/legal/docs`: Get legal agreement documents
- `POST /v1/applications/{applicationId}/documents/legal/accept`: Accept legal documents
- `GET /v1/applications/{applicationId}/documents/legal/acceptance`: Get legal document acceptance
- `PATCH /v1/applications/{applicationId}/agreements/legal/accept`: Queue legal agreement acceptance
- `POST /v1/applications/{applicationId}/documents`: Upload a KYC document
- `POST /v1/applications/{applicationId}/kyc/questions`: Submit KYC questionnaire answers
- `POST /v1/applications/{applicationId}/ubos/actions`: UBO actions
- `GET /v1/applications/{applicationId}/verification/status`: Get verification status
- `POST /v1/customers/{customerId}/documents/presign`: Get a document presign URL
- `POST /v1/access-management/invite/customer`: Invite a sub-user
- `GET /v1/customers/{customerId}/accounts`: List accounts
- `POST /v1/customers/{customerId}/accounts`: Open an additional account
- `GET /v1/customers/{customerId}/accounts/{accountId}/limits`: Get account limits
- `POST /v1/customers/{customerId}/accounts/{accountId}/limits`: Update account limits
- `POST /v1/customers/{customerId}/accounts/{accountId}/block`: Block an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/unblock`: Unblock an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/close`: Close an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/confirmation/send`: Account confirmation letter
- `GET /v1/customers/{customerId}/beneficiaries`: List beneficiaries
- `POST /v1/customers/{customerId}/beneficiaries`: Create a beneficiary
- `GET /v1/customers/{customerId}/beneficiaries/{beneficiaryId}`: Get a beneficiary
- `DELETE /v1/customers/{customerId}/beneficiaries/{beneficiaryId}`: Delete a beneficiary
- `POST /v1/beneficiaries/verify`: Verify a payee's name
- `POST /v1/customers/{customerId}/accounts/{accountId}/beneficiaries/international`: Create an international beneficiary
- `POST /v1/customers/{customerId}/beneficiaries/pin`: Request a security PIN
- `GET /v1/customers/{customerId}/accounts/{accountId}/cards`: Get cards
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards`: Create a card
- `GET /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}`: Get card details
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/activate`: Activate a card
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/block`: Block a card
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/unblock`: Unblock a card
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/cancel`: Cancel a card
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/pin/reset`: Reset card PIN
- `PATCH /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/limits`: Update card limit group
- `GET /v1/customers/{customerId}/accounts/{accountId}/secure-key`: Get secure key
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/secure/passkey-challenge`: Secure details — passkey challenge
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/secure`: Get secure card details
- `GET /v1/customers/{customerId}/3ds`: Get recent 3DS notifications
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/3ds/confirm`: Confirm a 3DS challenge
- `GET /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/transactions`: List card transactions
- `GET /v1/customers/{customerId}/accounts/{accountId}/cards/options`: Get card options
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/balance`: Load / unload card balance
- `POST /v1/customers/{customerId}/accounts/{accountId}/cardholders`: Create a cardholder
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/{cardId}/invite`: Invite a cardholder to a card
- `GET /v1/customers/{customerId}/accounts/{accountId}/cards/invites`: List card invites
- `DELETE /v1/customers/{customerId}/accounts/{accountId}/cards/invites/{invitedCustomerId}`: Revoke a card invite
- `POST /v1/customers/{customerId}/accounts/{accountId}/cards/auth/confirm`: Confirm a holder authentication
- `POST /v1/customers/{customerId}/accounts/{accountId}/payments`: Create a payment
- `POST /v1/customers/{customerId}/accounts/{accountId}/payments/international`: Create an international (FX) transfer
- `GET /v1/accounts/{accountId}/fx/quote`: Get an FX quote
- `GET /v1/payments/currencies`: List supported currencies
- `GET /v1/customers/{customerId}/accounts/{accountId}/payments/fee`: Calculate the fee for a payment
- `GET /v1/customers/{customerId}/accounts/{accountId}/scheduled-payments`: List scheduled payments
- `DELETE /v1/customers/{customerId}/accounts/{accountId}/scheduled-payments/{scheduleId}`: Delete a scheduled payment
- `GET /v1/customers/{customerId}/accounts/{accountId}/payments/requests`: List payment requests
- `GET /v1/customers/{customerId}/transactions`: List transactions
- `GET /v1/customers/{customerId}/accounts/{accountId}/statements`: Generate a statement
- `POST /v1/customers/{customerId}/batch-payments`: Batch action (verify / initiate / submit)
- `GET /v1/batch-payments/verify/{requestId}`: Get verify status
- `GET /v1/batch-payments`: List batches
- `POST /v1/batch-payments`: Custodian batch payments
- `GET /v1/batch-payments/{batchId}`: Get a batch
- `GET /v1/customers/{customerId}/fees`: Get customer fees
- `GET /v1/customers/{customerId}/limits`: Get customer limits

## Full text

- [Complete documentation](https://api-docs.orenda-apps.com/llms-full.txt): every page as plain text