# Orenda Management API

> The administrative API for back-office systems and operator tools.

## Get started

- [Management API](https://api-management-docs.orenda-apps.com/overview): The administrative API for back-office systems and operator tools.
- [Operator authentication](https://api-management-docs.orenda-apps.com/authentication): How back-office operators sign in and what roles exist.
- [Provision an identity](https://api-management-docs.orenda-apps.com/control-api): Create an identity and its application for your program with POST /identity.
- [Issuing cards for your users](https://api-management-docs.orenda-apps.com/issue-cards): End-to-end: provision a user, onboard them, then issue and fund a card.

## Oversight

- [Search](https://api-management-docs.orenda-apps.com/search): Find applications, accounts, transactions, cards, payments, and charges.
- [Reports](https://api-management-docs.orenda-apps.com/reports): Generate CSV/MT940 reports asynchronously and download them.
- [Payment approvals](https://api-management-docs.orenda-apps.com/payment-approvals): Review held payments and approve or reject them.

## Webhooks

- [Webhooks](https://api-management-docs.orenda-apps.com/webhooks): Events Orenda pushes to your system, signature verification, and delivery behaviour.
- [CUSTOMER_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/customer-status-update): Fires when a customer's onboarding/KYC status changes.
- [ACCOUNT_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/account-status-update): Fires when an account's status changes.
- [ACCOUNT_BALANCE_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/account-balance-update): Fires when an account's settled balance changes.
- [NEW_CARD_ADDED](https://api-management-docs.orenda-apps.com/webhooks/new-card-added): Fires when a new card is provisioned.
- [CARD_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/card-status-update): Fires when a card's lifecycle status changes.
- [CARD_AUTH_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/card-auth-status-update): Fires when a card authorisation / 3DS challenge is raised or resolved.
- [TRANSACTION_INITIATED](https://api-management-docs.orenda-apps.com/webhooks/transaction-initiated): Fires when a payment request is created.
- [TRANSACTION_CREATED](https://api-management-docs.orenda-apps.com/webhooks/transaction-created): Fires when a ledger transaction is created.
- [TRANSACTION_STATUS_CHANGED](https://api-management-docs.orenda-apps.com/webhooks/transaction-status-changed): Fires when a ledger transaction's status changes.

## Customer operations

- [Acting on a customer](https://api-management-docs.orenda-apps.com/customer-operations): Accounts, payments, beneficiaries, and batches on a customer's behalf.
- [Card operations](https://api-management-docs.orenda-apps.com/cards-operations): Manage a customer's cards: issue, control status, and limits.

## Configuration

- [Fees](https://api-management-docs.orenda-apps.com/fees): Read the program's fee catalog and generate fee documents.
- [Access management](https://api-management-docs.orenda-apps.com/access-management): Operators, software users, customer invites, and per-resource access grants.
- [Invite a customer](https://api-management-docs.orenda-apps.com/invite-customer): Back-office invite — plain customer or funded sub-role member, with step-up.

## API reference

- `GET /applications/search`: Search applications and customers
- `GET /accounts/search`: Search accounts
- `GET /transactions/search`: Search transactions
- `GET /cards/search`: Search cards
- `GET /cards/transactions/search`: Search card authorisations
- `GET /payments/search`: Search payments
- `GET /charges/search`: Search fee charges
- `GET /audit-trail/search`: Search the audit trail
- `GET /v1/access-management/me`: Get the caller's profile
- `GET /v1/access-management/program-claims`: List the caller's programs and permissions
- `GET /v1/access-management/bo-users`: List back-office users
- `GET /v1/access-management/software-users`: List software users
- `POST /v1/access-management/invite/customer`: Invite a customer
- `POST /v1/access-management/invite/guardian`: Invite a guardian
- `GET /v1/access-management/invited`: List invites you have sent
- `POST /v1/access-management/accesses`: Grant access to an account and/or card
- `PATCH /v1/access-management/accesses`: Update or revoke access grants
- `POST /customers/{customerId}/block`: Block a customer
- `POST /customers/{customerId}/unblock`: Unblock a customer
- `PATCH /customer/{customerId}`: Update a customer
- `POST /customers/{customerId}/update`: Update customer onboarding type
- `GET /customers/{customerId}/application-meta`: Get customer onboarding metadata
- `POST /v1/customers/{customerId}/accounts/{accountId}/block`: Block an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/unblock`: Unblock an account
- `POST /v1/customer/{customerId}/account/{accountId}/close`: Close an account
- `PATCH /account/{accountId}`: Update an account's tier
- `POST /v1/customer/{customerId}/account/{accountId}/confirmation/send`: Send account confirmation letter
- `POST /v1/customer/{customerId}/account/{accountId}/available-balance/queue`: Queue available-balance recalculation
- `GET /customers/{customerId}/accounts/{accountId}/notifications`: Get pending account notifications
- `PATCH /customers/{customerId}/accounts/{accountId}/sync-card-balance`: Sync card balance with provider
- `POST /customers/{customerId}/accounts/{accountId}/load-unload-balance`: Load or unload card balance
- `POST /customers/{customerId}/beneficiaries/name-verification`: Verify a payee name (CoP / VoP)
- `GET /v1/payments/requests`: List payment requests
- `POST /v1/payments/requests/status`: Resolve payment requests
- `POST /customers/{customerId}/accounts/{accountId}/payments/compliance-trigger`: Transaction-monitoring decision
- `POST /charges/trigger-charge`: Re-trigger a stuck charge
- `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/reports/mt940`: MT940 report (synchronous)
- `POST /v1/reports/mt940`: MT940 report (asynchronous email)
- `GET /v1/ai-reviews`: List a target's reviews (paginated)
- `POST /v1/ai-reviews`: Queue an AI review
- `GET /v1/ai-reviews/{reviewId}`: Fetch one AI review
- `POST /v1/ai-validation/applications/{applicationId}/kyc-step`: AI-validate a KYC questionnaire step (consumer, advisory)

## Full text

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