# Caliza Documentation > Documentation for Caliza ## Guides: Overview - [Introduction to Caliza](https://docs.caliza.com/docs/what-is-caliza.md) - [Caliza Core Concepts](https://docs.caliza.com/docs/calizas-core-concepts.md) - [Coverage](https://docs.caliza.com/docs/coverage.md) ## Guides: Quickstart - [Authenticate](https://docs.caliza.com/docs/authenticate.md) - [Get the Integrator ID](https://docs.caliza.com/docs/get-the-integrator-id.md) - [Create a Beneficiary](https://docs.caliza.com/docs/create-beneficiaries.md) - [Create USD Virtual Accounts](https://docs.caliza.com/docs/create-virtual-accounts.md) - [Create Recipients](https://docs.caliza.com/docs/manage-recipients.md) - [Send Your First Payment](https://docs.caliza.com/docs/send-your-first-payment.md) - [Webhooks](https://docs.caliza.com/docs/webhooks.md): Real-time notifications for transaction and beneficiary lifecycle events ## Guides: Financial Operations - [Beneficiaries](https://docs.caliza.com/docs/manage-beneficiaries.md) - [Related Persons](https://docs.caliza.com/docs/related-persons.md) - [KYC/KYB Verification](https://docs.caliza.com/docs/kyc-kyb-verification.md) - [Payments](https://docs.caliza.com/docs/payments.md) - [Payment On Behalf Of (POBO)](https://docs.caliza.com/docs/payment-on-behalf-of.md) - [Document validation and review](https://docs.caliza.com/docs/document-validation-and-review.md) - [Exchanges](https://docs.caliza.com/docs/exchanges.md) - [FX Rate Locks](https://docs.caliza.com/docs/fx-rate-locks.md) - [Stablecoin Deposits](https://docs.caliza.com/docs/stablecoin-deposits.md) - [Crypto Travel Rule](https://docs.caliza.com/docs/crypto-travel-rule.md) - [Self-Hosted Wallets](https://docs.caliza.com/docs/self-hosted-wallets.md) - [Travel Rule Migration Guide](https://docs.caliza.com/docs/travel-rule-migration-guide.md) - [Retrieving Transactions and Payments](https://docs.caliza.com/docs/retrieving-transactions-and-payments.md) - [Internal Transfers](https://docs.caliza.com/docs/internal-transfers.md): Move funds between beneficiaries within the same integrator account - [Account Sweeps](https://docs.caliza.com/docs/account-sweeps.md) - [Fiat Deposits](https://docs.caliza.com/docs/fiat-deposits.md) ## Guides: Technical Details - [Webhook Events](https://docs.caliza.com/docs/webhook-events.md): Complete reference of all webhook event types and their payloads - [Webhook Signature Validation](https://docs.caliza.com/docs/webhook-signature-validation-guide.md): How to verify the authenticity of incoming webhook requests - [API Error Catalog](https://docs.caliza.com/docs/api-error-catalog.md): Complete reference of error codes and validation errors across all API endpoints ## Guides: Testing & Development - [Mock Fiat Deposits](https://docs.caliza.com/docs/mock-fiat-deposits.md) - [Mock Stablecoin Deposits](https://docs.caliza.com/docs/mock-stablecoin-deposits.md) - [Testing Travel Rule in Sandbox](https://docs.caliza.com/docs/testing-travel-rule-in-sandbox.md) ## API Reference: Introduction - [Overview](https://docs.caliza.com/reference/overview.md) - [Authentication](https://docs.caliza.com/reference/authentication-1.md) - [Response Codes](https://docs.caliza.com/reference/response-codes.md) ## API Reference: Caliza API - Transactions - [Simulate transaction or payment](https://docs.caliza.com/reference/createsimulation_1.md): Creates a simulation to preview and calculate all costs associated with a transaction before executing it. The simulation returns estimated total costs, itemized fees, exchange rates (if currency… - [Create new transaction](https://docs.caliza.com/reference/createtransaction.md): Initiates a new financial transaction including payments, payouts, or currency conversions between accounts. Before calling this endpoint, you must create a simulation to preview fees and exchange… - [Retrieve a simulation](https://docs.caliza.com/reference/getsimulationbyid.md): Retrieves the details of a previously created transaction simulation including estimated fees, exchange rates, settlement times, and total costs. Use this to review simulation parameters before… - [Retrieve transaction details](https://docs.caliza.com/reference/gettransactionbyid.md): Retrieves comprehensive information about a specific transaction including current status with timestamp (created, processing, completed, failed, cancelled), source and destination details, original… - [Download proof of payment document](https://docs.caliza.com/reference/gettransactionproofofpayment.md): Downloads the proof of payment document for a specific transaction in the specified format. If no format type is specified, the system will auto-detect the appropriate format based on transaction… - [Execute batch payout](https://docs.caliza.com/reference/payouts.md): Processes multiple payout transactions in a single batch operation, efficiently distributing funds to multiple recipients according to defined amounts and settlement methods. This is ideal for use… - [List transactions](https://docs.caliza.com/reference/getalltransactions.md): Retrieves a paginated list of transactions associated with your integrator account. Use query parameters to filter by beneficiary, currency, status, date range, and amount range. Results are returned… - [Retrieve transaction simulation (v2)](https://docs.caliza.com/reference/getsimulationbyidv2.md): Retrieves the details of a previously created transaction simulation with enhanced v2 data including detailed fee breakdown by type (network fees, service fees, conversion fees), step-by-step… - [Retrieve transaction with documents](https://docs.caliza.com/reference/gettransactionbyidwithdocuments.md): Retrieves complete transaction details along with all attached supporting documents including invoices, receipts, contracts, proof of payment PDFs, and any compliance-related files. Use this when you… - [Upload supporting documents to a transaction](https://docs.caliza.com/reference/uploaddocument.md): Attaches one or more supporting documents to an existing transaction and triggers document validation. Use this to provide documentation after a transaction has been created — most importantly to… - [Create transaction with supporting documents](https://docs.caliza.com/reference/createtransaction_1.md): Initiates a new transaction and simultaneously attaches required supporting documentation. This is particularly important for high-value transactions, cross-border payments, or transactions requiring… - [Get deposit instructions](https://docs.caliza.com/reference/getdepositinstructions.md): Retrieves detailed, step-by-step instructions for a beneficiary to deposit funds using the specified payment rail. Returns beneficiary-specific bank account details (account number, routing number),… - [Execute account sweep payout](https://docs.caliza.com/reference/sweeppayouts.md): Automatically consolidates and transfers available balances from multiple beneficiary accounts to a designated destination account in a single operation. This is commonly used for treasury… - [Simulate transaction or payment (v2)](https://docs.caliza.com/reference/createsimulation.md): Creates an enhanced v2 transaction simulation that calculates and previews all costs, exchange rates, and requirements before executing a transaction. The v2 version provides more detailed breakdowns… - [Export transactions to CSV](https://docs.caliza.com/reference/getalltransactions_1_1.md): Generates and downloads a CSV file containing all transactions matching the specified filter criteria (date range, status, currency, beneficiary, etc.). The CSV includes transaction details, amounts,… - Transactions (Sandbox) - [Simulate SPEI deposit (sandbox)](https://docs.caliza.com/reference/createfakespeiindeposit.md): Creates a simulated SPEI (Sistema de Pagos Electrónicos Interbancarios - Mexican interbank electronic payment system) deposit for testing purposes in the sandbox environment. This allows you to test… - [Simulate PIX deposit (sandbox)](https://docs.caliza.com/reference/createfakepixindeposit.md): Creates a simulated PIX (Pix Instant Payment - Brazilian instant payment system) deposit for testing deposit flows, balance updates, and webhook notifications in the sandbox environment. PIX is… - [Simulate USD deposit (sandbox)](https://docs.caliza.com/reference/createfakeusddeposit.md): Creates a simulated USD deposit via wire transfer for testing international payment flows, balance updates, and webhook notifications in the sandbox environment. This simulates deposits from U.S.… - [Simulate crypto deposit (sandbox)](https://docs.caliza.com/reference/createfakecryptodeposit.md): Creates a simulated cryptocurrency deposit arriving at a DFNS wallet in the sandbox environment. Use this to test crypto deposit detection, balance updates, webhook notifications, and any custom… - [Simulate Travel Rule clearance (sandbox)](https://docs.caliza.com/reference/simulatetravelruleclearance.md): Resolves the Travel Rule decision a transaction is waiting on in the sandbox environment, standing in for the counterparty that never responds there. For a crypto payout paused on Travel Rule… - [Simulate PIX payout confirmation (sandbox)](https://docs.caliza.com/reference/createfakepixindeposit_1.md): Triggers a simulated webhook event notification for PIX payout confirmation in the sandbox environment. Use this to test your webhook handlers for successful payout completion, verify your webhook… - Payments - [Create payment with supporting documents](https://docs.caliza.com/reference/createpaymentwithdocuments.md): Initiates a new payment transaction and attaches required supporting documentation such as invoices, receipts, purchase orders, commercial agreements, or proof of goods/services. This is particularly… - [Create new payment](https://docs.caliza.com/reference/createpayment.md): Initiates a payment transaction to transfer funds between accounts or to external recipients. Before calling this endpoint, you must first create a simulation using the /v1/simulations or… - [Get payment instructions](https://docs.caliza.com/reference/getpaymentinstructions.md): Retrieves detailed, step-by-step payment instructions for a beneficiary to deposit funds using the specified payment rail. Instructions include recipient bank details (account number, routing number,… - [Update payment blockchain hash](https://docs.caliza.com/reference/updatetransactionhash_1.md): Associates a blockchain transaction hash (transaction ID) with a payment deposit record, enabling on-chain verification and providing immutable proof of cryptocurrency payment execution. After a user… - [Retrieve payment details](https://docs.caliza.com/reference/gettransactionbyid_1.md): Retrieves complete information about a specific payment transaction including current status (created, processing, completed, failed), amounts sent and received, applied fees and exchange rates,… - Beneficiaries - [Retrieve beneficiary details](https://docs.caliza.com/reference/getbeneficiary.md): Retrieves all information about a specific beneficiary including personal or business details, KYC/KYB verification status, account status, balances, and associated metadata. Use this to check a… - [Update beneficiary information](https://docs.caliza.com/reference/updatebeneficiary.md): Modifies existing beneficiary details such as contact information, addresses, identification documents, or business data. Use this when a beneficiary's information changes (such as a new address,… - [Remove beneficiary](https://docs.caliza.com/reference/deletebeneficiary.md): Permanently deletes a beneficiary from the system. This action cannot be undone and will remove all associated data including virtual accounts, wallet addresses, and preferences, except for… - [Retrieve multi-currency balance details](https://docs.caliza.com/reference/getbeneficiarydetailedbalancebycurrencies.md): Returns comprehensive balance information across multiple currencies for a specific beneficiary. For each requested currency, this endpoint provides available balance (funds ready for withdrawal),… - [Record terms and conditions acceptance](https://docs.caliza.com/reference/accepttermsandconditions.md): Registers a beneficiary's explicit acceptance of the platform's terms and conditions, creating an auditable record of consent with timestamp, IP address, and version information. This is typically… - [Enable beneficiary account](https://docs.caliza.com/reference/enablebeneficiary.md): Activates a previously disabled beneficiary account, restoring full access to all platform features and transaction capabilities. Use this when re-enabling an account that was temporarily suspended… - [Disable beneficiary account](https://docs.caliza.com/reference/disablebeneficiary.md): Temporarily suspends a beneficiary account, immediately preventing new transactions from being initiated while preserving all existing data, transaction history, and pending transactions for… - [List beneficiary virtual accounts](https://docs.caliza.com/reference/listvirtualaccounts.md): Retrieves all virtual accounts associated with a beneficiary. Virtual accounts are unique account numbers assigned to a beneficiary for receiving funds in specific currencies. Each virtual account… - [Generate new virtual account](https://docs.caliza.com/reference/createvirtualaccount.md): Creates a new virtual account for the beneficiary in the specified currency and region. Virtual accounts enable beneficiaries to receive funds through unique account identifiers (account number +… - [Retrieve beneficiary account balance](https://docs.caliza.com/reference/getbeneficiarybalance.md): Returns the current balance for a beneficiary's account in the specified currency. The balance includes available funds (ready for withdrawal or payment) and may also show pending transactions that… - [List all beneficiaries](https://docs.caliza.com/reference/getall.md): Retrieves a paginated list of all beneficiaries associated with your integrator account. Beneficiaries are the individuals or businesses that can send or receive funds through your platform. Results… - [Register new beneficiary](https://docs.caliza.com/reference/savebeneficiary.md): Creates a new beneficiary record for an individual or business with initial KYC/KYB information and account settings. For individuals, provide personal details (name, date of birth, ID number,… - [Retrieve detailed balance breakdown](https://docs.caliza.com/reference/getbeneficiarydetailedbalance.md): Provides a comprehensive, itemized breakdown of a beneficiary's balance in the specified currency. This includes available balance (funds that can be withdrawn immediately), pending balance (deposits… - [Get or create cryptocurrency wallet](https://docs.caliza.com/reference/findorcreatewallet.md): Retrieves an existing cryptocurrency wallet address for the beneficiary on the specified blockchain network, or automatically creates a new wallet if none exists. Each beneficiary can have multiple… - Related Person - [Create related person](https://docs.caliza.com/reference/createrelatedperson.md): Creates a new related person for a beneficiary such as a beneficial owner, director, legal representative, or authorized signatory. Provide personal details including name, date of birth,… - [List related persons](https://docs.caliza.com/reference/listrelatedpersons.md): Retrieves all related persons associated with a beneficiary including beneficial owners, directors, legal representatives, and authorized signatories. Each entry includes full personal details,… - [Get related person](https://docs.caliza.com/reference/getrelatedperson.md): Retrieves detailed information about a specific related person including personal details, contact information, residential address, and any uploaded compliance documents. Use this to inspect… - [Update related person](https://docs.caliza.com/reference/updaterelatedperson.md): Updates the information of an existing related person including personal details, contact information, and residential address. Use this when a related person's information changes or when correcting… - [Delete related person](https://docs.caliza.com/reference/deleterelatedperson.md): Removes a related person from a beneficiary's record. Use this when a related person is no longer associated with the beneficiary entity, for example when an owner sells their stake or a director… - [Upload document for related person](https://docs.caliza.com/reference/addrelatedpersondocument.md): Uploads an identity or compliance document for a specific related person of a beneficiary. Documents can include government-issued IDs (passport, driver's license, national ID), proof of address, or… - Integrators - [Retrieve webhook secret key](https://docs.caliza.com/reference/getintegratorwebhooksecret.md): Retrieves the current webhook secret key used to validate webhook signatures from Caliza. Use this secret to verify that webhook notifications genuinely originate from Caliza and haven't been… - [Rotate webhook secret key](https://docs.caliza.com/reference/updateintegratorwebhooksecret.md): Generates and sets a new webhook secret for enhanced security. Use this periodically to rotate secrets as a security best practice or immediately if you suspect the current secret has been… - [Get current integrator profile](https://docs.caliza.com/reference/getme.md): Retrieves complete profile information for the currently authenticated integrator including business details, contact information, configuration settings, enabled features, webhook URLs, and account… - [Update integrator profile](https://docs.caliza.com/reference/updateme.md): Modifies integrator account information such as business details, contact information (email, phone), banking preferences, notification settings, and webhook configurations. Some fields may require… - [Retrieve integrator account balances](https://docs.caliza.com/reference/getintegratorbalances.md): Returns current balance information across all currencies and accounts associated with the integrator. For each currency, this shows available balance (funds ready for use), pending balance (funds… - [Get webhook configuration](https://docs.caliza.com/reference/getintegratorwebhooks.md): Retrieves the currently configured webhook URL and event subscription settings. Webhooks enable real-time event notifications from the Caliza platform to your application. The configuration includes… - [Configure webhook endpoint](https://docs.caliza.com/reference/updatewebhookconfig.md): Sets or updates the webhook URL and event subscription preferences for receiving automated, real-time notifications about platform events. Configure which events trigger webhooks (transaction… - Integrator Capabilities - [List integrator capabilities](https://docs.caliza.com/reference/getcapabilitiesbyintegratorid.md): Retrieves all enabled features, permissions, and access levels for your integrator account. This includes supported currencies (fiat and crypto), available transaction types (payments, payouts,… - Recipients - [List all recipients](https://docs.caliza.com/reference/getrecipients.md): Retrieves a paginated list of all saved payment recipients for a specific beneficiary. Recipients are individuals or businesses that have been registered as payout destinations. Each recipient… - [Register new recipient](https://docs.caliza.com/reference/createrecipient.md): Creates a new payment recipient profile with complete bank account details, contact information, and payment preferences. Recipients are destinations where you can send payouts. Include details like… - [Retrieve recipient details](https://docs.caliza.com/reference/getrecipient.md): Retrieves complete information about a specific saved recipient including full name (individual) or business name, bank account details (account number, routing number, SWIFT/BIC), contact… - [Update recipient information](https://docs.caliza.com/reference/updaterecipient.md): Modifies existing recipient details such as bank account information (if bank changed accounts), contact details (email, phone), recipient address, or payment preferences. Sensitive changes like bank… - [Remove recipient](https://docs.caliza.com/reference/deleterecipient.md): Permanently deletes a recipient from your saved recipients list. This only removes the recipient profile - all past transactions with this recipient will remain in your transaction history for audit… - [Search the VASP directory](https://docs.caliza.com/reference/searchvasps.md): Searches the directory of Virtual Asset Service Providers (crypto exchanges and custodial wallet providers) available for crypto recipient creation. Returns a paginated list of VASPs matching the… - Travel Rule - [Issue a delegate token for the SafeConnect components](https://docs.caliza.com/reference/issuedelegatetoken.md): Issues the short-lived access token that the SafeConnect frontend components require to produce a wallet ownership proof, scoped to the recipient's beneficiary. Your frontend passes this token to the… - [Submit a signature ownership proof](https://docs.caliza.com/reference/submitproof.md): Submits a wallet ownership proof produced by signing an attestation message with the wallet's private key — the output of the SafeConnect frontend components, or an equivalent raw proof assembled by… - [Issue the attestation for a manual-signing ownership proof](https://docs.caliza.com/reference/issuemanualattestation.md): Returns the exact attestation text the wallet holder must sign with the wallet's own key, and the signature scheme to submit it under — for wallets that cannot use the SafeConnect components. The… - [Start a microtransfer (Satoshi test) ownership proof](https://docs.caliza.com/reference/startmicrotransfertest.md): Starts a microtransfer ownership test for the recipient's self-hosted wallet, as an alternative to a signature proof. The response carries the transfer instructions; the proof is verified… - [Get the current ownership proof for a recipient](https://docs.caliza.com/reference/getproof.md): Returns the current wallet ownership proof covering the recipient's wallet address: either the VERIFIED, unexpired proof, or the PENDING microtransfer test still awaiting its on-chain deposit… - [Get the Travel Rule deposit info for a beneficiary](https://docs.caliza.com/reference/getdepositinfo.md): Returns the information a depositor's VASP needs to originate the Travel Rule message for a crypto deposit into the beneficiary's Caliza wallet: Caliza's VASP name and DID, plus the beneficiary's… - KYC/KYB - [Create verification](https://docs.caliza.com/reference/createverification.md): Creates an interactive KYC or KYB verification session for a beneficiary. The system determines whether to run KYC (for individuals) or KYB (for businesses) based on the beneficiary type. Returns a… - [Get verification status](https://docs.caliza.com/reference/getverificationstatus.md): Retrieves the current verification status for a beneficiary. Returns the verification session details including the current status, verification URL (if still pending), and timestamps. Use this… - [Approve verification (sandbox)](https://docs.caliza.com/reference/approveverificationsandbox.md): Manually approves a KYX verification in sandbox environments without going through the third-party verification provider. After approval, the beneficiary status is updated and all downstream flows… - Terms and Conditions - [Retrieve T&C document](https://docs.caliza.com/reference/gettermsandconditions.md): Retrieves the current version of the platform's terms and conditions document in PDF or HTML format. The response includes the version number and effective date for compliance tracking and audit…