# Zodia Documentation

## Docs

- [Onboarding with Claude Code](https://docs.zodia-custody.com/ai-guides/claude-code-onboarding.md): Use Claude Code to guide yourself through your first Zodia API integration, step by step.
- [Get the estimated fee rate by currency](https://docs.zodia-custody.com/api-reference/api--blockchain-fees--v2/get-the-estimated-fee-rate-by-currency.md)
- [Retrieve fee details of a ledger](https://docs.zodia-custody.com/api-reference/api--blockchain-fees--v2/retrieve-fee-details-of-a-ledger.md)
- [Ping GET](https://docs.zodia-custody.com/api-reference/api--misc--v2/ping-get.md)
- [Create new outgoing transaction](https://docs.zodia-custody.com/api-reference/api--transactions--v2/create-new-outgoing-transaction.md)
- [Get an incoming transaction by ID](https://docs.zodia-custody.com/api-reference/api--transactions--v2/get-an-incoming-transaction-by-id.md)
- [Get an outgoing transaction by ID](https://docs.zodia-custody.com/api-reference/api--transactions--v2/get-an-outgoing-transaction-by-id.md)
- [Get the payload to approve/reject new outgoing transaction](https://docs.zodia-custody.com/api-reference/api--transactions--v2/get-the-payload-to-approvereject-new-outgoing-transaction.md)
- [Get the payload to create new outgoing transaction](https://docs.zodia-custody.com/api-reference/api--transactions--v2/get-the-payload-to-create-new-outgoing-transaction.md)
- [Return transactions statistics](https://docs.zodia-custody.com/api-reference/api--transactions--v2/return-transactions-statistics.md)
- [Submit the payload to approve/reject new outgoing transaction](https://docs.zodia-custody.com/api-reference/api--transactions--v2/submit-the-payload-to-approvereject-new-outgoing-transaction.md)
- [Submit the payload to create new outgoing transaction](https://docs.zodia-custody.com/api-reference/api--transactions--v2/submit-the-payload-to-create-new-outgoing-transaction.md)
- [Create new wallet](https://docs.zodia-custody.com/api-reference/api--wallets--v2/create-new-wallet.md)
- [Get incoming transactions by wallet ID](https://docs.zodia-custody.com/api-reference/api--wallets--v2/get-incoming-transactions-by-wallet-id.md)
- [Get outgoing transactions by wallet ID](https://docs.zodia-custody.com/api-reference/api--wallets--v2/get-outgoing-transactions-by-wallet-id.md)
- [Get the payload to approve/reject new wallet](https://docs.zodia-custody.com/api-reference/api--wallets--v2/get-the-payload-to-approvereject-new-wallet.md)
- [Get the payload to create new wallet](https://docs.zodia-custody.com/api-reference/api--wallets--v2/get-the-payload-to-create-new-wallet.md)
- [Return a single wallet by ID](https://docs.zodia-custody.com/api-reference/api--wallets--v2/return-a-single-wallet-by-id.md)
- [Return a wallet address for a given currency](https://docs.zodia-custody.com/api-reference/api--wallets--v2/return-a-wallet-address-for-a-given-currency.md)
- [Return all wallets](https://docs.zodia-custody.com/api-reference/api--wallets--v2/return-all-wallets.md)
- [Submit the payload to approve/reject new wallet](https://docs.zodia-custody.com/api-reference/api--wallets--v2/submit-the-payload-to-approvereject-new-wallet.md)
- [Submit the payload to create new wallet](https://docs.zodia-custody.com/api-reference/api--wallets--v2/submit-the-payload-to-create-new-wallet.md)
- [Create a trustline for an XLM (Stellar) asset](https://docs.zodia-custody.com/api-reference/custody-v3/create-a-trustline-for-an-xlm-stellar-asset.md): For an account to hold assets other than XLM, it must establish a trustline with the issuing account of that particular asset. Each trustline increases the account’s base reserve by 0.5 XLM, which means the account will have to hold more XLM in its minimum balance.
- [Retrieve an address for a wallet](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-an-address-for-a-wallet.md): Use for generating the address for the created wallet, and use it for receiving deposits from external.
- [Retrieve fee details of a ledger](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-fee-details-of-a-ledger.md)
- [Retrieve gas tank wallets link to your vault](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-gas-tank-wallets-link-to-your-vault.md)
- [Retrieve ledger fees per currency](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-ledger-fees-per-currency.md)
- [Retrieve supported currencies](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-supported-currencies.md): Gets all the available currencies with details such as name, id and ledger etc.
- [Retrieve transactions](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-transactions.md): Gets all the transactions based on filter criteria.
- [Retrieve trustline for a wallet and a currency](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-trustline-for-a-wallet-and-a-currency.md)
- [Retrieve wallet balances](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallet-balances.md)
- [Retrieve wallets](https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets.md): Gets the custody wallets based on the filter criteria.
- [Returns list of generated addresses of wallets](https://docs.zodia-custody.com/api-reference/custody-v3/returns-list-of-generated-addresses-of-wallets.md): Gets all the generated addresses of a wallet.
- [Check the status of the settlement instructions](https://docs.zodia-custody.com/api-reference/interchange-v3/check-the-status-of-the-settlement-instructions.md)
- [Confirm or reject a withdrawal from a trading vault](https://docs.zodia-custody.com/api-reference/interchange-v3/confirm-or-reject-a-withdrawal-from-a-trading-vault.md)
- [Create a settlement instruction](https://docs.zodia-custody.com/api-reference/interchange-v3/create-a-settlement-instruction.md)
- [List interchange whitelisted addresses](https://docs.zodia-custody.com/api-reference/interchange-v3/list-interchange-whitelisted-addresses.md): List the addresses whitelisted with [/v3/api/interchange/settlement/transactions](#tag/Interchange-V3/operation/getV3ApiInterchangeWhitelistSender) endpoint
- [Retrieve all vaults](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-all-vaults.md)
- [Retrieve all wallets](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-all-wallets.md)
- [Retrieve an address for a vault](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-an-address-for-a-vault.md): Use for receiving deposits from external sources
- [Retrieve an address for a wallet](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-an-address-for-a-wallet.md): Use for receiving deposits from external sources
- [Retrieve settlement wallet for Venue](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-settlement-wallet-for-venue.md)
- [Retrieve settlements](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-settlements.md)
- [Retrieve transactions](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-transactions.md)
- [Retrieve wallet balances](https://docs.zodia-custody.com/api-reference/interchange-v3/retrieve-wallet-balances.md)
- [Return list of generated addresses](https://docs.zodia-custody.com/api-reference/interchange-v3/return-list-of-generated-addresses.md)
- [Return list of generated addresses for settlement wallet](https://docs.zodia-custody.com/api-reference/interchange-v3/return-list-of-generated-addresses-for-settlement-wallet.md)
- [Return list of generated addresses for vaults](https://docs.zodia-custody.com/api-reference/interchange-v3/return-list-of-generated-addresses-for-vaults.md)
- [Whitelist senders for settlement transactions](https://docs.zodia-custody.com/api-reference/interchange-v3/whitelist-senders-for-settlement-transactions.md)
- [Activate or Deactivate VASP](https://docs.zodia-custody.com/api-reference/network-v3/activate-or-deactivate-vasp.md): Used for reactivating or deactivating a VASP.
- [Create VASP](https://docs.zodia-custody.com/api-reference/network-v3/create-vasp.md): Used for creating a VASP.
- [Retrieve addresses](https://docs.zodia-custody.com/api-reference/network-v3/retrieve-addresses.md)
- [Retrieve beneficiaries](https://docs.zodia-custody.com/api-reference/network-v3/retrieve-beneficiaries.md)
- [Retrieve onboarded VASPs](https://docs.zodia-custody.com/api-reference/network-v3/retrieve-onboarded-vasps.md)
- [Retrieve transfer rules](https://docs.zodia-custody.com/api-reference/network-v3/retrieve-transfer-rules.md)
- [Update VASP](https://docs.zodia-custody.com/api-reference/network-v3/update-vasp.md): Used for updating a VASP.
- [Get Staking Balances](https://docs.zodia-custody.com/api-reference/reporting-v3/get-staking-balances.md): Retrieve staking balances
- [Get Staking Report Data](https://docs.zodia-custody.com/api-reference/reporting-v3/get-staking-report-data.md): Available staking Report Data
- [Approve or reject an instruction](https://docs.zodia-custody.com/api-reference/servicedesk-v3/approve-or-reject-an-instruction.md): This is followed by pending API call, to confirm/approve the instructions for service request. If pending API returns empty, it means there is nothing to approve.
- [Create service request](https://docs.zodia-custody.com/api-reference/servicedesk-v3/create-service-request.md): This creates new service request for the requested service or operation
- [List service requests](https://docs.zodia-custody.com/api-reference/servicedesk-v3/list-service-requests.md): Search past and present service requests.
- [Retrieve audit trail](https://docs.zodia-custody.com/api-reference/servicedesk-v3/retrieve-audit-trail.md): This will return the audit-trail of given service request with details such as status, pending approvals and approved history.
- [Retrieve products and services](https://docs.zodia-custody.com/api-reference/servicedesk-v3/retrieve-products-and-services.md): Available products and services are derived from the entitlements of the user
- [Retrieve the instruction to sign](https://docs.zodia-custody.com/api-reference/servicedesk-v3/retrieve-the-instruction-to-sign.md): This retrieves the instructions if the given service request is pending approval for the user (i.e. submitter-id). If there is no approval pending, it will return empty response. Please check the service request status to make sure its not expired or timed out.
- [Submit service request](https://docs.zodia-custody.com/api-reference/servicedesk-v3/submit-service-request.md): This will submit the given service request, initiates the request workflow.
- [Authentication](https://docs.zodia-custody.com/authentication.md): How to authenticate with the Zodia Custody API
- [Extracting Your Public Key](https://docs.zodia-custody.com/authentication/extract-public-key.md): How to derive a public key from your private key in the format Zodia requires
- [Signing the Payload](https://docs.zodia-custody.com/authentication/signing-payload.md): How makers and authorisers sign instruction payloads using their ECC keys
- [Signing Requests](https://docs.zodia-custody.com/authentication/signing-requests.md): How to create and attach the RSA signature required for all API requests
- [FAQs](https://docs.zodia-custody.com/faqs.md): Frequently asked questions about the Zodia API.
- [Welcome](https://docs.zodia-custody.com/index.md)
- [Interchange Guide](https://docs.zodia-custody.com/interchange-guide.md): Trade directly from your segregated custody wallet using Zodia's Interchange service.
- [Approval Modes](https://docs.zodia-custody.com/interchange-guide/approval-modes.md): Understand the joint and one-party approval models for Interchange settlement.
- [Getting Started (Client)](https://docs.zodia-custody.com/interchange-guide/client.md): Steps for clients to set up and use Zodia Interchange.
- [Getting Started (Trading Venue)](https://docs.zodia-custody.com/interchange-guide/trading-venue.md): Steps for trading venues to set up and use Zodia Interchange settlement.
- [Introduction](https://docs.zodia-custody.com/introduction.md): Zodia Custody API — institutional-grade digital asset custody
- [Rate Limiting & Pagination](https://docs.zodia-custody.com/rate-limiting.md): API rate limits and how to paginate results
- [Service Desk Guide](https://docs.zodia-custody.com/service-desk-guide.md): End-to-end workflows for wallets, beneficiaries, whitelisting, and transfers using the Digital Asset Service Desk
- [Beneficiary Creation](https://docs.zodia-custody.com/service-desk-guide/beneficiary-creation.md): How to create a beneficiary using the Digital Asset Service Desk API
- [Instruct a Transfer](https://docs.zodia-custody.com/service-desk-guide/instruct-transfer.md): How to instruct a transfer from a wallet to a whitelisted address
- [Products & Services](https://docs.zodia-custody.com/service-desk-guide/products-and-services.md): Overview of products and services available through the Digital Asset Service Desk
- [Wallet Creation](https://docs.zodia-custody.com/service-desk-guide/wallet-creation.md): How to create a wallet using the Digital Asset Service Desk API
- [Whitelist an Address](https://docs.zodia-custody.com/service-desk-guide/whitelist-address.md): How to whitelist an address for a beneficiary
- [Staking Guide](https://docs.zodia-custody.com/staking-guide.md): Learn about Zodia's staking feature and how to enable it for your account.
- [Status Reference](https://docs.zodia-custody.com/status-reference.md): Reference guide for all status values used across the Zodia API
- [Interchange Statuses](https://docs.zodia-custody.com/status-reference/interchange.md): Status values for interchange settlement requests
- [Service Desk Statuses](https://docs.zodia-custody.com/status-reference/service-desk.md): Status values for Digital Asset Service Desk requests
- [Transfer Statuses](https://docs.zodia-custody.com/status-reference/transfer.md): Status values for transfers
- [Wallet Statuses](https://docs.zodia-custody.com/status-reference/wallet.md): Status values for wallets
- [Webhooks](https://docs.zodia-custody.com/webhooks.md): Configure notifications for wallet, beneficiary, and transfer lifecycle events
- [Using JMS](https://docs.zodia-custody.com/webhooks/jms.md): Configure webhook notifications using JMS (Java Message Service)
- [Using REST API](https://docs.zodia-custody.com/webhooks/rest-api.md): Configure webhook notifications using the REST API
- [What's New.](https://docs.zodia-custody.com/whats-new.md): Recent additions and improvements to the Zodia API documentation
- [Working with APIs](https://docs.zodia-custody.com/working-with-apis.md): Platform basics, TLS requirements, maker-checker model, and shared conventions
- [Company Onboarding](https://docs.zodia-custody.com/working-with-apis/company-onboarding.md): How to onboard your company for API interaction
- [Error Codes](https://docs.zodia-custody.com/working-with-apis/error-codes.md): Standard error codes returned by the Zodia API
- [Interchange Error Codes](https://docs.zodia-custody.com/working-with-apis/interchange-error-codes.md): Error codes specific to Interchange API operations
- [Onboarding API Users](https://docs.zodia-custody.com/working-with-apis/onboarding-api-users.md): How to onboard individual API users (makers and checkers)
- [Pagination](https://docs.zodia-custody.com/working-with-apis/pagination.md): How to paginate through list API results
- [Pre-requisites](https://docs.zodia-custody.com/working-with-apis/pre-requisites.md): What you need before calling the Zodia API

## OpenAPI Specs

- [api_specification](https://docs.zodia-custody.com/api-reference/api_specification.yaml)