# Delos

## API Docs

- [Introduction](https://docs.delos.financial/introduction.md)
- [Login](https://docs.delos.financial/authentication/login.md): Authenticates a user and returns access/refresh tokens for API authorization. Supports optional 2FA verification.
- [Otp Confirm](https://docs.delos.financial/authentication/otp-confirm.md): Verifies a one-time password (OTP) for two-factor authentication (2FA) and completes the login process. Returns success status upon valid OTP confirmation.
- [Otp Disable](https://docs.delos.financial/authentication/otp-disable.md): Disables two-factor authentication (2FA) for a user account after verifying a valid one-time password (OTP). Returns success status upon completion.
- [Otp Enable](https://docs.delos.financial/authentication/otp-enable.md): Initiates two-factor authentication (2FA) setup by generating a new OTP secret and QR code for authenticator apps (Google Authenticator, Authy, etc.).
- [Get Profile](https://docs.delos.financial/authentication/get-profile.md): Retrieves authenticated user and partner profile information, including 2FA status.
- [Recovery Confirm](https://docs.delos.financial/authentication/recovery-confirm.md): Finalizes password recovery by verifying a security code and token, then setting a new password. Returns new authentication tokens upon success.
- [Recovery Access](https://docs.delos.financial/authentication/recovery-access.md): Initiates the password recovery process by sending a verification code to the user's registered email or phone number. Returns a temporary token for the next recovery step.
- [Refresh Access Token](https://docs.delos.financial/authentication/refresh-access-token.md): Generates a new access token using a valid refresh token, extending the user's session without requiring reauthentication.
- [List Customers](https://docs.delos.financial/customer/list-customers.md): Retrieves a paginated list of customers with filtering options. Returns customer details including balances, status, and metadata.
- [Add Customer](https://docs.delos.financial/customer/add-customer.md): Creates a new customer with the provided details. Returns the newly created customer object with system-generated IDs and default balances.
- [Get Customer](https://docs.delos.financial/customer/get-customer.md): Retrieves detailed information about a specific customer including balances, contact information, and status.
- [Update Customer](https://docs.delos.financial/customer/update-customer.md): Updates an existing customer's information including status, contact details, and metadata. Returns the updated customer object.
- [Share Verified KYC/KYB Data](https://docs.delos.financial/compliance/share-verified-kyc-kyb-data.md)
- [Get Compliance Link](https://docs.delos.financial/compliance/get-compliance-link.md)
- [Get Customer Application](https://docs.delos.financial/application/get-customer-application.md): Retrieves comprehensive customer application information including personal/business details, investment profiles, KYC data, and associated documents.
- [Set Customer Application (deprecated)](https://docs.delos.financial/application/set-customer-application-deprecated.md)
- [Send Customer Application](https://docs.delos.financial/application/send-customer-application.md)
- [Get account list](https://docs.delos.financial/accounts/get-account-list.md): This command is to retrieve a list of accounts (payment wallets) for a specific partner or customer. It can be needed to check overall accounts’ balances and statuses for a particular client.
- [Create account](https://docs.delos.financial/accounts/create-account.md): This command is to create an account (payment wallet) for a specific customer. Creates a new account with the specified currency and owner. Returns the newly created account details, including balance
- [Get account by ID](https://docs.delos.financial/accounts/get-account-by-id.md)
- [Update Account](https://docs.delos.financial/accounts/update-account.md): Updates an existing account's properties, including its name, default flag, and status. Returns the updated account details.
- [Get counterparty list](https://docs.delos.financial/counterparties/get-counterparty-list.md): Retrieves a paginated list of counterparties (business partners, clients, or related entities) with comprehensive filtering options and detailed profile information.
- [Create counterparty](https://docs.delos.financial/counterparties/create-counterparty.md): Creates a new counterparty (business partner, client, or related entity) with comprehensive profile information and associated bank/crypto accounts.
- [Get Account List](https://docs.delos.financial/counterparties/get-account-list.md): Retrieves a paginated list of counterparty accounts with comprehensive filtering options.
- [Get Account](https://docs.delos.financial/counterparties/get-account.md): Retrieves detailed information about a specific counterparty account, including comprehensive bank details, crypto wallet information, counterparty and customer relationships, and account status.
- [Get counterparty](https://docs.delos.financial/counterparties/get-counterparty.md)
- [Update counterparty](https://docs.delos.financial/counterparties/update-counterparty.md): Updates an existing counterparty's information including profile details, addresses, business relationships, and associated accounts.
- [Create counterparty account](https://docs.delos.financial/counterparties/create-counterparty-account.md): Creates a new bank or cryptocurrency account for an existing counterparty. This allows counterparties to have multiple accounts in different currencies and payment methods.
- [Update counterparty account](https://docs.delos.financial/counterparties/update-counterparty-account.md): Updates an existing counterparty account's information including bank details, crypto wallet information, account status, and payment configurations.
- [List Client Operations](https://docs.delos.financial/operations/list-client-operations.md): Retrieves a paginated list of client financial operations (transactions) with comprehensive filtering options. Includes detailed information about sources, destinations, amounts, and operation status.
- [Add Client Operation](https://docs.delos.financial/operations/add-client-operation.md): Creates a new financial operation for a client. Supports various operation types including transfers, deposits, withdrawals, and exchanges with flexible source/destination configurations.
- [Prepare Client Operation](https://docs.delos.financial/operations/prepare-client-operation.md): Simulates and validates a financial operation without executing it.
- [Get Operation](https://docs.delos.financial/operations/get-operation.md): Retrieves detailed information about a specific financial operation, including complete transaction details, amounts, status, and associated documents.
- [Add Document](https://docs.delos.financial/operations/add-document.md): Attaches an existing document to a specific operation. This is used to associate supporting documentation (invoices, contracts, etc.) with financial operations for compliance, verification, and audit
- [Remove Document](https://docs.delos.financial/operations/remove-document.md): Removes a previously attached document from a specific operation. This allows for document management and correction of document associations without affecting the operation itself.
- [Get Customer Operation Tree](https://docs.delos.financial/operations/get-customer-operation-tree.md): Retrieves a hierarchical view of a customer operation, including the main (parent) operation and all its related child operations.
- [Get Commissions](https://docs.delos.financial/commissions/get-commissions.md): Retrieves commission configurations with comprehensive filtering capabilities.
- [Set Commission](https://docs.delos.financial/commissions/set-commission.md): Creates or updates a commission configuration for specific transaction parameters.
- [List Commission Accounts](https://docs.delos.financial/commissions/list-commission-accounts.md): Retrieves a paginated list of commission accounting configurations.
- [Upload document](https://docs.delos.financial/documents/upload-document.md): Uploads a document for a customer using multipart/form-data.
- [List Documents](https://docs.delos.financial/documents/list-documents.md): Retrieves a paginated list of all documents associated with a specific customer.
- [Download Document](https://docs.delos.financial/documents/download-document.md): Downloads the actual file content of a specific customer document.
- [Delete Document](https://docs.delos.financial/documents/delete-document.md): Permanently deletes a specific document associated with a customer.
- [Document update](https://docs.delos.financial/documents/document-update.md): Updates the metadata of an existing customer document.
- [Get Document Information](https://docs.delos.financial/documents/get-document-information.md): Retrieves detailed metadata and status information for a specific customer document.
- [Upload File](https://docs.delos.financial/files/upload-file.md): Uploads a document/file to the storage system and associates it with a customer.
- [List Files](https://docs.delos.financial/files/list-files.md): Retrieves a paginated list of files from the storage system, optionally filtered by customer ID.
- [Download File](https://docs.delos.financial/files/download-file.md): Downloads a specific file from the storage system by its unique ID. Returns the raw file content with appropriate Content-Type headers for direct file access or display in browsers.
- [Delete File](https://docs.delos.financial/files/delete-file.md): Removes a specific file from the storage system by its unique ID. This operation performs a soft delete, marking the file as deleted while potentially retaining it in the system for audit purposes.
- [List Limits](https://docs.delos.financial/limits/list-limits.md): Retrieves a paginated list of transaction limits with comprehensive filtering options. Limits define minimum and maximum amounts for various operation types and payment methods.
- [Set Limit](https://docs.delos.financial/limits/set-limit.md): Creates or updates transaction limits for operations. Can set system-wide limits or customer-specific limits for various operation types and payment methods.
- [Get Hook Parameters](https://docs.delos.financial/hooks/get-hook-parameters.md): Retrieves the current webhook configuration settings. Webhooks allow your system to receive real-time notifications about events in the payment system.
- [Set Hook Parameters](https://docs.delos.financial/hooks/set-hook-parameters.md)
- [Get Partner](https://docs.delos.financial/partner/get-partner.md): Retrieves information about the current partner associated with the provided API key. This endpoint returns essential partner details including unique identifier, name, and current status. Useful for
- [Page](https://docs.delos.financial/partner/page.md)
- [List Currencies](https://docs.delos.financial/currency/list-currencies.md): Retrieves a list of available currencies with their details including exchange rates and currency types (fiat/crypto).
- [Convert](https://docs.delos.financial/currency/convert.md): Converts an amount from one currency to another using current exchange rates. Returns both the original and converted amounts.
- [Get Currency](https://docs.delos.financial/currency/get-currency.md): Retrieves detailed information about a specific currency including its exchange rate and properties.
- [List users](https://docs.delos.financial/users/list-users.md): Retrieves a paginated list of users with comprehensive filtering and search capabilities. This endpoint is designed for user management, allowing administrators to find and monitor users based on vari
- [Add user](https://docs.delos.financial/users/add-user.md): Creates a new user account in the system. This endpoint allows administrators to register new users with basic account information and credentials.
- [Delete user](https://docs.delos.financial/users/delete-user.md): Permanently deletes a user account from the system. This operation is irreversible and removes all user data associated with the account. Use with caution.
- [Update user](https://docs.delos.financial/users/update-user.md): Updates an existing user's information. This endpoint allows modification of various user properties including password, status, personal information, and account settings. Only include the fields you
- [Get user](https://docs.delos.financial/users/get-user.md): Retrieves comprehensive details for a specific user account. This endpoint returns complete user information including profile data, security settings, MFA requirements, and associated client relation
- [Bind client](https://docs.delos.financial/users/bind-client.md): Establishes or updates a relationship between a user and a client/customer account. This endpoint links a user to a specific customer, defining their access level and permissions within that client ac
- [Remove bind client](https://docs.delos.financial/users/remove-bind-client.md): Removes a relationship between a user and a client/customer account. This endpoint disassociates a user from a specific customer, revoking their access and permissions for that client account.
- [Country List](https://docs.delos.financial/geo/country-list.md)
- [States list](https://docs.delos.financial/geo/states-list.md): Retrieves a paginated list of states/regions with their geographic identifiers.
- [Account requisites](https://docs.delos.financial/report/account-requisites.md): Retrieves detailed account requisites report for a specific account. This endpoint provides comprehensive banking and account information for customer reference and payment processing.
- [Counterparty account requisites](https://docs.delos.financial/report/counterparty-account-requisites.md)
- [Operations list](https://docs.delos.financial/report/operations-list.md): This method returns an operations report as an Excel (XLSX) file encoded in Base64 format.
- [Operation Detail](https://docs.delos.financial/report/operation-detail.md): Retrieves the detailed report or data file for a specific operation. This is used to fetch the results of a previously executed operation, such as a generated report, export file, or audit log.
- [Account Statement](https://docs.delos.financial/report/account-statement.md): Generates and retrieves account statements for a specific user within a defined time period. Supports multiple export formats for financial reporting and record-keeping.
- [Event list](https://docs.delos.financial/messages/event-list.md): Retrieves a paginated list of available system events and their variables. This is useful for understanding what events can be used in notifications or webhooks and what data they provide.
- [Get Settings](https://docs.delos.financial/messages/get-settings.md): Retrieves the current system configuration settings including common application settings and email service configuration. This endpoint provides essential information about the platform's operational
- [Update Settings](https://docs.delos.financial/messages/update-settings.md): Updates system configuration settings including common application parameters and email service configuration. This endpoint allows administrators to modify operational settings.
- [Get templates list](https://docs.delos.financial/messages/get-templates-list.md): Retrieves a paginated list of message templates with their configuration, triggers, and associated events. Templates are used for automated notifications (email, SMS, etc.) triggered by system events.
- [Create template account](https://docs.delos.financial/messages/create-template-account.md): Creates a new message template for automated notifications (email, SMS, etc.). Templates are triggered by system events and can include dynamic variables.
- [Get template by ID](https://docs.delos.financial/messages/get-template-by-id.md): Retrieves detailed information about a specific message template, including its content, configuration, and associated trigger events.
- [Delete template by ID](https://docs.delos.financial/messages/delete-template-by-id.md): Permanently deletes a message template. This action is irreversible and will prevent the template from being triggered by any future events.
- [Update template account](https://docs.delos.financial/messages/update-template-account.md): Updates an existing message template. Allows modification of template content, configuration, triggers, and activation status. Returns the updated template with current values.
- [Type list](https://docs.delos.financial/messages/type-list.md): Retrieves a paginated list of available message types with their configuration and permission status. This endpoint helps understand what types of messages can be sent and which are enabled for the cu
- [FAQ](https://docs.delos.financial/faq.md)
- [Configuring Partner Verification Levels](https://docs.delos.financial/configuring-partner-verification-levels.md)

## Webhooks

- [Enable Webhooks](https://docs.delos.financial/webhooks/enable-webhooks.md)
- [Validate Requests](https://docs.delos.financial/webhooks/validate-requests.md)
- [Hook Structure](https://docs.delos.financial/webhooks/hook-structure.md)
- [Receive Customer](https://docs.delos.financial/webhooks/receive-customer.md)
- [Receive Account](https://docs.delos.financial/webhooks/receive-account.md)
- [Receive Operation](https://docs.delos.financial/webhooks/receive-operation.md)
- [Receive Counterparty](https://docs.delos.financial/webhooks/receive-counterparty.md)

## Validation

- [Counterparties](https://docs.delos.financial/validation/counterparties.md)
- [Transaction creation](https://docs.delos.financial/validation/transaction-creation.md)
- [KYB](https://docs.delos.financial/validation/kyb.md)
- [KYC](https://docs.delos.financial/validation/kyc.md)

## Infrastructure Overview

- [Glossary](https://docs.delos.financial/baas-wiki/basics/editor.md): Below you can find the list of the main terms that you are going to face when using API or/and Baas admin panel.
- [FAQ](https://docs.delos.financial/baas-wiki/basics/markdown.md)
- [Integration process](https://docs.delos.financial/baas-wiki/basics/images-and-media.md)
- [White Label Documentation](https://docs.delos.financial/baas-wiki/basics/interactive-blocks.md): Below you will find a guide on how to white-label our terms and conditions for your customers.
- [KYC/KYB Requirements](https://docs.delos.financial/baas-wiki/basics/kyc-kyb-requirements.md)
- [KYC/KYB Overview](https://docs.delos.financial/baas-wiki/basics/kyc-kyb-overview.md)
- [Application fields breakdown](https://docs.delos.financial/baas-wiki/basics/application-fields-breakdown.md)
- [Required data for platform development](https://docs.delos.financial/baas-wiki/basics/integrations.md)
- [SLAs and statuses](https://docs.delos.financial/baas-wiki/basics/slas-and-statuses.md)
- [Transactions Screening Compliance Guide](https://docs.delos.financial/baas-wiki/basics/transactions-screening-compliance-guide.md)
- [Sign in](https://docs.delos.financial/baas-wiki/admin-panel-overview/sign-in.md)
- [Dashboard](https://docs.delos.financial/baas-wiki/admin-panel-overview/dashboard.md)
- [Customers](https://docs.delos.financial/baas-wiki/admin-panel-overview/customers.md)
- [Users](https://docs.delos.financial/baas-wiki/admin-panel-overview/users.md)
- [Recipients](https://docs.delos.financial/baas-wiki/admin-panel-overview/recipients.md)
- [Create payment](https://docs.delos.financial/baas-wiki/admin-panel-overview/create-payment.md)
- [Transactions](https://docs.delos.financial/baas-wiki/admin-panel-overview/transactions.md)
- [Settings](https://docs.delos.financial/baas-wiki/admin-panel-overview/settings.md)
- [Registration & KYB](https://docs.delos.financial/baas-wiki/ui-overview/registration-and-kyb.md)
- [Password reset, 2fa, data change](https://docs.delos.financial/baas-wiki/ui-overview/password-reset-2fa-data-change.md)
- [Payment accounts](https://docs.delos.financial/baas-wiki/ui-overview/payment-accounts.md)
- [Counterparties](https://docs.delos.financial/baas-wiki/ui-overview/counterparties.md)
- [Deposit](https://docs.delos.financial/baas-wiki/ui-overview/deposit.md)
- [Exchange | On/Off Ramp](https://docs.delos.financial/baas-wiki/ui-overview/exchange-or-on-off-ramp.md)
- [Withdrawal](https://docs.delos.financial/baas-wiki/ui-overview/withdrawal.md)
- [Commissions](https://docs.delos.financial/baas-wiki/ui-overview/commissions.md)
- [Transaction history and statements](https://docs.delos.financial/baas-wiki/ui-overview/transaction-history-and-statements.md)
- [Multifactor Authentication](https://docs.delos.financial/baas-wiki/ui-overview/multifactor-authentication.md)

## Changelog

- [Changelog](https://docs.delos.financial/changelog/readme.md): New updates and improvements


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.delos.financial/introduction.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.