# Blaaiz - [Home](https://docs.business.blaaiz.com/home.md): Global Payment APIs - Connect to Swift, SEPA, ACH & More in Days - [Getting Started](https://docs.business.blaaiz.com/guides/getting-started.md): Learn how to get started with the Blaaiz Platform API Services - [Authentication](https://docs.business.blaaiz.com/guides/authentication.md): Learn how to authenticate your API requests to the Blaaiz API. - [IP whitelisting](https://docs.business.blaaiz.com/guides/ip-whitelisting.md): Learn how to whitelist your IP addresses for API access - [SDKs](https://docs.business.blaaiz.com/guides/sdks.md): Supercharge your integration with Blaaiz SDKs - [General Guidelines](https://docs.business.blaaiz.com/guides/general-guidelines.md): Guidelines for using the Blaaiz Platform API - [Money movement](https://docs.business.blaaiz.com/guides/money-movement.md): How funds flow through Blaaiz for collections, payouts, and wallets - [API parameters](https://docs.business.blaaiz.com/guides/api-parameters.md): Common parameters used across Blaaiz API endpoints - [Rate and usage limits](https://docs.business.blaaiz.com/guides/rate-limits.md): Understand API rate limits and usage restrictions - [Creating your first payout](https://docs.business.blaaiz.com/guides/creating-first-payout.md): Step-by-step guide to creating your first payout - [Crypto API](https://docs.business.blaaiz.com/guides/crypto-api.md): Create customer wallet addresses, swap balances, and send crypto payouts. - [Business customer KYB](https://docs.business.blaaiz.com/guides/kyb/overview.md): How to onboard a business-type customer through the Know Your Business (KYB) flow. - [Onboarding a business customer](https://docs.business.blaaiz.com/guides/kyb/onboarding.md): End-to-end walkthrough for creating, populating, and submitting a business-type customer for KYB. - [Handling KYB rejections](https://docs.business.blaaiz.com/guides/kyb/handling-rejections.md): How to read admin feedback, fix the right things, and re-submit a rejected business customer. - [Customer data corrections](https://docs.business.blaaiz.com/guides/customer-data-corrections.md): How to request changes to verified customer records that can no longer be updated via the API - [Collections overview](https://docs.business.blaaiz.com/guides/collections-overview.md): Understanding collections and how to attach customers to transactions - [Refunding a collection](https://docs.business.blaaiz.com/guides/refunding-a-collection.md): Refund a collection back to its original sender, and track the refund lifecycle - [Virtual Bank Accounts](https://docs.business.blaaiz.com/guides/virtual-bank-accounts.md): How to create and manage Virtual Bank Accounts for receiving payments - [Interac Auto Deposits](https://docs.business.blaaiz.com/guides/interac-auto-deposits.md): Register an Interac auto-deposit email through the API or dashboard, check its status, and receive CAD collections. - [Interac Money Requests](https://docs.business.blaaiz.com/guides/interac-money-requests.md): Learn how Interac money requests work on Blaaiz and how to pull CAD collections by requesting funds from a payer. - [Common use cases](https://docs.business.blaaiz.com/guides/common-use-cases.md): Real-world scenarios showing how businesses use the Blaaiz Platform API - [Cross-border remittances](https://docs.business.blaaiz.com/guides/use-cases/cross-border-remittances.md): Build a remittance product that collects in one currency and pays out in another - [Multi-currency wallets and liquidity management](https://docs.business.blaaiz.com/guides/use-cases/liquidity-management.md): Mirror user swaps on Blaaiz to keep wallet liquidity balanced across currencies - [Virtual accounts for deposit collection](https://docs.business.blaaiz.com/guides/use-cases/virtual-accounts-deposit-collection.md): Issue dedicated bank accounts to customers for automatic deposit reconciliation - [🇨🇦 Interac CAD collections](https://docs.business.blaaiz.com/guides/use-cases/interac-collections.md): Collect CAD from customers via Interac Auto Deposit and identify senders using webhook emails - [🇨🇦 Interac money requests](https://docs.business.blaaiz.com/guides/use-cases/interac-money-requests.md): Request CAD from a payer via the API — Blaaiz sends an Interac money request and credits your wallet when they approve - [Marketplace and platform payouts](https://docs.business.blaaiz.com/guides/use-cases/marketplace-payouts.md): Collect from buyers and disburse to sellers across multiple countries - [Crypto on/off-ramps](https://docs.business.blaaiz.com/guides/use-cases/crypto-on-off-ramps.md): Receive stablecoins and move value between crypto and fiat wallets - [B2B invoice and vendor payments](https://docs.business.blaaiz.com/guides/use-cases/b2b-vendor-payments.md): Automate cross-border vendor payments via optimal local rails - [Payroll for distributed teams](https://docs.business.blaaiz.com/guides/use-cases/payroll.md): Pay employees and contractors in their local currency from a single wallet - [Webhook events and payloads](https://docs.business.blaaiz.com/guides/webhooks/events.md): Reference for Blaaiz webhook event types and common payload structure - [NGN](https://docs.business.blaaiz.com/guides/webhooks/collection/ngn.md): Webhook payload for NGN collection transactions - [CAD](https://docs.business.blaaiz.com/guides/webhooks/collection/cad.md): Webhook payload for CAD collection transactions - [USD](https://docs.business.blaaiz.com/guides/webhooks/collection/usd.md): Webhook payload for USD collection transactions - [GBP](https://docs.business.blaaiz.com/guides/webhooks/collection/gbp.md): Webhook payload for GBP collection transactions - [EUR](https://docs.business.blaaiz.com/guides/webhooks/collection/eur.md): Webhook payload for EUR collection transactions - [NGN](https://docs.business.blaaiz.com/guides/webhooks/payout/ngn.md): Webhook payload for NGN payout transactions - [CAD](https://docs.business.blaaiz.com/guides/webhooks/payout/cad.md): Webhook payload for CAD payout transactions - [USD](https://docs.business.blaaiz.com/guides/webhooks/payout/usd.md): Webhook payload for USD payout transactions - [EUR](https://docs.business.blaaiz.com/guides/webhooks/payout/eur.md): Webhook payload for EUR payout transactions - [GBP](https://docs.business.blaaiz.com/guides/webhooks/payout/gbp.md): Webhook payload for GBP payout transactions - [Refund](https://docs.business.blaaiz.com/guides/webhooks/refund.md): Webhook payload for refunds of a collection back to source - [Interac auto-deposit email](https://docs.business.blaaiz.com/guides/webhooks/interac-auto-deposit-email.md): Registration status events for Interac auto-deposit emails - [Code examples for signature verification](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/overview.md): Verify webhook signatures to ensure payload integrity and authenticity - [PHP](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/php.md): Verify webhook signatures using PHP - [JavaScript](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/javascript.md): Verify webhook signatures using JavaScript - [Customer](https://docs.business.blaaiz.com/guides/webhooks/customer.md): Webhook payloads for customer verification events - [Virtual account](https://docs.business.blaaiz.com/guides/webhooks/virtual-account.md): Webhook payloads for virtual account events - [Wallet & collection basics](https://docs.business.blaaiz.com/faq/wallet-collection-basics.md): Common questions about wallets and collections - [Collection methods by currency](https://docs.business.blaaiz.com/faq/collection-methods.md): Learn how to collect payments in different currencies - [Virtual bank accounts](https://docs.business.blaaiz.com/faq/virtual-bank-accounts.md): Frequently asked questions about virtual bank accounts - [Fees and processing](https://docs.business.blaaiz.com/faq/fees-and-processing.md): Understanding transaction fees and processing - [Webhooks and notifications](https://docs.business.blaaiz.com/faq/webhooks-and-notifications.md): Learn about webhook notifications for transactions - [Payment links and redirections](https://docs.business.blaaiz.com/faq/payment-links.md): Understanding when and how to use payment links - [API integration](https://docs.business.blaaiz.com/faq/api-integration.md): Common questions about integrating with the Blaaiz API - [Business customer KYB](https://docs.business.blaaiz.com/faq/kyb.md): Common questions about onboarding and verifying type=business customers. - [Overview](https://docs.business.blaaiz.com/api-reference/overview.md): Complete API reference for the Blaaiz Platform API - [Get OAuth access token](https://docs.business.blaaiz.com/api-reference/authentication/get-oauth-access-token.md): Exchange your OAuth client credentials for a short-lived access token. Submit this request as application/x-www-form-urlencoded. Use the returned Bearer token on subsequent calls to /api/external/* endpoints. Client credentials tokens do not return refresh tokens. - [Retrieve all virtual bank accounts](https://docs.business.blaaiz.com/api-reference/retrieve-all-virtual-bank-accounts.md): Fetches all virtual bank accounts (VBAs) for the specified wallet. Required scope: `virtual-account:read`. - [Create virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/create-virtual-bank-account.md): Generates a new virtual bank account for the specified wallet. Supports NGN, GBP, USD, EUR. - [Retrieve a single virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/retrieve-a-single-virtual-bank-account.md): Retrieves details of a specific virtual bank account by its ID. Required scope: `virtual-account:read`. - [Get identification type](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/get-identification-type.md): Look up the country-specific identification type that a customer must provide as their `tin` value. Each country uses a different identification system (e.g. SSN in the US, BVN in Nigeria, NINO in the UK), and individual vs business customers within the same country may require different types. Call… - [Close a virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/close-a-virtual-bank-account.md): Initiate closure of a virtual bank account. Supported currencies: GBP, EUR, NGN, USD. Returns 400 if already closed or provider/currency not supported; 404 if not found. Required scope: `virtual-account:close`. - [List all banks](https://docs.business.blaaiz.com/api-reference/bank/list-all-banks.md): Retrieve all supported banks. Filter by currency or country if desired. Required scope: `bank:read`. - [Resolve bank account](https://docs.business.blaaiz.com/api-reference/bank/resolve-bank-account.md): Verify the validity of a bank account by providing account number and bank_id. Required scope: `bank:read`. - [Verify GBP payee](https://docs.business.blaaiz.com/api-reference/bank/verify-gbp-payee.md): Run a Confirmation-of-Payee check on a GBP account. Blaaiz returns a match or no-match result and never returns the real account name. Required scope: `bank:read`. - [Verify EUR IBAN](https://docs.business.blaaiz.com/api-reference/bank/verify-eur-iban.md): Check if a EUR IBAN is reachable on the SEPA and SEPA Instant networks. Required scope: `bank:read`. - [Create a payout](https://docs.business.blaaiz.com/api-reference/payout/create-a-payout.md): > **Do not use `method: "crypto"` with this endpoint.** Use the Crypto API for wallet swaps and on-chain crypto payouts. - [Get fees breakdown](https://docs.business.blaaiz.com/api-reference/fees/get-fees-breakdown.md): Calculate fees for a transaction between two currencies. Provide either from_amount or to_amount (not both). Send customer_id to get the fees that apply to that customer. Required scope: `fees:read`. - [List rates](https://docs.business.blaaiz.com/api-reference/rate/list-rates.md): Retrieve exchange rates applicable to the authenticated business. - [List all currencies](https://docs.business.blaaiz.com/api-reference/currency/list-all-currencies.md): Retrieve all supported currencies. Required scope: `currency:read`. - [List all wallets](https://docs.business.blaaiz.com/api-reference/wallet/list-all-wallets.md): Retrieve all business wallets. Required scope: `wallet:read`. - [Get wallet](https://docs.business.blaaiz.com/api-reference/wallet/get-wallet.md): Retrieve a single wallet by ID. Required scope: `wallet:read`. - [Initiate a collection](https://docs.business.blaaiz.com/api-reference/collection/initiate-a-collection.md): Create a card collection request for a business wallet. Card collections require a verified customer and card details, and may not be enabled for every business. Customer attachment after creation is not supported for API card collections. Required scope: `collection:create`. - [Attach customer to collection](https://docs.business.blaaiz.com/api-reference/collection/attach-customer-to-collection.md): Associate a collection transaction with a verified customer. - [Accept Interac money request](https://docs.business.blaaiz.com/api-reference/collection/accept-interac-money-request.md): Accept an Interac transfer into your business wallet. Required scope: `collection:interac:accept`. - [Initiate Interac money request](https://docs.business.blaaiz.com/api-reference/collection/initiate-interac-money-request.md): Send an Interac money request to a payer's email to collect CAD into your business wallet. Blaaiz creates a pending collection and sends the request to the payer; when they approve it from their bank app, the funds settle into your CAD wallet and a collection webhook is emitted. Required scope: `col… - [Initiate crypto collection](https://docs.business.blaaiz.com/api-reference/collection/initiate-crypto-collection.md): Initiate a crypto collection to fund a wallet using cryptocurrency. Required scope: `collection:crypto:create`. - [Get crypto networks](https://docs.business.blaaiz.com/api-reference/collection/get-crypto-networks.md): Retrieve all available blockchain networks and their supported tokens. Required scope: `collection:crypto:create`. - [Register an Interac auto-deposit email](https://docs.business.blaaiz.com/api-reference/interac-auto-deposit-email/register-an-interac-auto-deposit-email.md): Submit an email for external setup by Blaaiz. API services must be enabled and your business must have a CAD wallet. The email must pass the same uniqueness checks as dashboard registration. A deleted business Interac registration does not reserve its email. This endpoint creates a PENDING request;… - [List Interac auto-deposit emails](https://docs.business.blaaiz.com/api-reference/interac-auto-deposit-email/list-interac-auto-deposit-emails.md): List live registrations owned by your business, including registrations from the dashboard and the API. The API returns 10 records per page, ordered by last update time from newest to oldest. Deleted records are excluded. The response has a data array, links, and pagination metadata in meta. An empt… - [Get an Interac auto-deposit email](https://docs.business.blaaiz.com/api-reference/interac-auto-deposit-email/get-an-interac-auto-deposit-email.md): Read one live registration owned by your business. Use the ID returned when you created or listed the registration. The response reflects the latest admin status update. An unknown ID, deleted record, or another business's record returns 404. API services must be enabled. - [Initiate a refund](https://docs.business.blaaiz.com/api-reference/refund/initiate-a-refund.md): Refund a collection back to its original sender. Blaaiz refunds the full collection amount only; there is no `amount` field. The collection must belong to one of your business customers, be created through the API, and be a successful EUR or GBP ClearJunction collection. The refund must start wi… - [Get a refund](https://docs.business.blaaiz.com/api-reference/refund/get-a-refund.md): Retrieve a refund by its refund ID. Only refunds of collections that you created through the API are returned. Required scope: `refund:read`. - [Swap money between business wallets](https://docs.business.blaaiz.com/api-reference/swap/swap-money-between-business-wallets.md): Swap money between two wallets owned by your business. The wallets must exist, belong to the same business, and use different currencies. This endpoint is available only when your business is allowed to perform API-services swaps. Required scope: `swap:create`. - [List crypto assets](https://docs.business.blaaiz.com/api-reference/crypto/list-crypto-assets.md): Get active crypto assets and active networks. Required scope: `crypto-asset:read`. - [List crypto wallets](https://docs.business.blaaiz.com/api-reference/crypto/list-crypto-wallets.md): Get crypto wallets that belong to your business. Required scope: `crypto-wallet:read`. - [Create customer wallet addresses](https://docs.business.blaaiz.com/api-reference/crypto/create-customer-wallet-addresses.md): Create static wallet addresses for one eligible business customer. Blaaiz creates an address for each active wallet network. Required scope: `crypto-wallet:create`. - [Get a crypto wallet](https://docs.business.blaaiz.com/api-reference/crypto/get-a-crypto-wallet.md): Get a crypto wallet. Required scope: `crypto-wallet:read`. - [List crypto wallet addresses](https://docs.business.blaaiz.com/api-reference/crypto/list-crypto-wallet-addresses.md): Get deposit addresses for one business crypto wallet. To get the addresses for one customer, use the optional `customer_id` query parameter. Required scope: `crypto-wallet:read`. - [List crypto wallet transactions](https://docs.business.blaaiz.com/api-reference/crypto/list-crypto-wallet-transactions.md): Get API-created crypto transactions for one wallet. Required scope: `crypto-transaction:read`. - [List crypto transactions](https://docs.business.blaaiz.com/api-reference/crypto/list-crypto-transactions.md): Get API-created crypto transactions for your business. Required scope: `crypto-transaction:read`. - [Get a crypto transaction](https://docs.business.blaaiz.com/api-reference/crypto/get-a-crypto-transaction.md): Get one API-created crypto transaction. An active on-chain payout returns `processing`. A payout that ends unsuccessfully returns `failed`. Required scope: `crypto-transaction:read`. - [Create a crypto payout](https://docs.business.blaaiz.com/api-reference/crypto/create-a-crypto-payout.md): Send crypto to an external address. The source wallet must belong to your business. The customer must belong to your business and have a VERIFIED status. The address must not be a Blaaiz wallet address. The request needs approved KYB and an `Idempotency-Key`. Required scope: `crypto-payout:create`. - [Create a crypto swap](https://docs.business.blaaiz.com/api-reference/crypto/create-a-crypto-swap.md): Swap crypto to crypto, crypto to fiat, or fiat to crypto. Both wallets must belong to your business. The request needs approved KYB and an `Idempotency-Key`. Required scope: `crypto-swap:create`. - [Request file upload URL](https://docs.business.blaaiz.com/api-reference/file/request-file-upload-url.md): **Individual customers only.** Request a pre-signed URL to upload a legacy 4-slot KYC file for an individual customer. - [Get transaction](https://docs.business.blaaiz.com/api-reference/transaction/get-transaction.md): Retrieve a completed API transaction by its transaction ID, its reference, or the merchant_reference that you supplied. Required scope: `transaction:read`. - [List transactions](https://docs.business.blaaiz.com/api-reference/transaction/list-transactions.md): Retrieve a paginated list of completed API transactions for your business. You can filter by date range, status, customer, wallet, and transaction type. Use `type: SWAP` to return only swap transactions. Required scope: `transaction:read`. - [Create a customer](https://docs.business.blaaiz.com/api-reference/customer/create-a-customer.md): Create a new customer. Verification stays `PENDING` until the type-specific verification flow completes. - [List all customers](https://docs.business.blaaiz.com/api-reference/customer/list-all-customers.md): Retrieve customers for your business. Supports optional exact-match filters on `email`, `id_number`, `registration_number`, `verification_status`, and `type`, and opt-in pagination via `paginate=true`. Filters and pagination compose. - [Get a customer](https://docs.business.blaaiz.com/api-reference/customer/get-a-customer.md): Retrieve customer details by ID. Required scope: `customer:read`. - [Update a customer](https://docs.business.blaaiz.com/api-reference/customer/update-a-customer.md): Update customer profile details. Non-verified customers can update all fields. Verified customers can only update fields that are currently null — if you need to correct a mistake on a verified customer (wrong document, misspelled name, incorrect details), you must request a manual correction from t… - [Add KYC details](https://docs.business.blaaiz.com/api-reference/customer/add-kyc-details.md): Add KYC details for a customer. Verification stays PENDING until documents are uploaded and reviewed. The customer's country must match the country on the identity document submitted for KYC. Accepted identity documents: Driver's License, Passport, or Resident Permit for individual customers, Certif… - [Upload files for a customer](https://docs.business.blaaiz.com/api-reference/customer/upload-files-for-a-customer.md): **Individual customers only.** Upload verification files for an individual customer. Use `file_id` values from the File API presigned upload. Newly uploaded files override previous records. The `id_file` must be uploaded for verification. - [Submit customer for verification](https://docs.business.blaaiz.com/api-reference/customer/submit-customer-for-verification.md): Locks the customer for review and starts the verification flow. The customer's `verification_status` flips out of `PENDING` (or `REJECTED` on re-submission). - [Upgrade a business customer from MINIMAL to FULL KYB](https://docs.business.blaaiz.com/api-reference/customer/upgrade-a-business-customer-from-minimal-to-full-kyb.md): Promote a `kyb_scope=MINIMAL` business customer to `kyb_scope=FULL` by attaching beneficial-owner data. Identity columns (`registration_number`, `incorporation_country`) are typically already on file from MINIMAL onboarding. - [List customer KYB documents](https://docs.business.blaaiz.com/api-reference/customer/list-customer-kyb-documents.md): Returns every KYB document the business has registered for this customer. Each row's `url` is a 2-minute presigned link to the underlying file. The customer must be of type `business`. Required scope: `customer:read`. - [Show a customer KYB document](https://docs.business.blaaiz.com/api-reference/customer/show-a-customer-kyb-document.md): Retrieves a single KYB document by ID. The customer must be of type `business` and the document must belong to the supplied customer. Required scope: `customer:read`. - [Get a KYB document upload URL](https://docs.business.blaaiz.com/api-reference/customer/get-a-kyb-document-upload-url.md): Two-step upload, step one. Returns a `file_id`, a presigned `url`, and the headers required to PUT the file directly to S3. The URL is valid for 5 minutes and accepts a single PUT. - [Register a KYB document](https://docs.business.blaaiz.com/api-reference/customer/register-a-kyb-document.md): Use after PUTting a file to the presigned URL. The server verifies that the upload exists, checks size and MIME, and stores the document with status `PENDING`. - [Update a KYB document](https://docs.business.blaaiz.com/api-reference/customer/update-a-kyb-document.md): Edit `type`, `name`, `description`, or replace the underlying file by supplying a new `file_id` from a fresh presigned URL call. Send only the fields you want to change. - [Delete a KYB document](https://docs.business.blaaiz.com/api-reference/customer/delete-a-kyb-document.md): Removes a KYB document from the customer's collection. Returns 400 if the document is locked (status APPROVED or PROCESSING). Required scope: `customer:write`. - [Get an owner ID-file upload URL](https://docs.business.blaaiz.com/api-reference/customer/get-an-owner-id-file-upload-url.md): Two-step upload, step one. Returns a `file_id`, a presigned `url`, and the headers required to PUT the file directly to S3. URL is valid for 5 minutes and accepts a single PUT. - [Register owner ID files](https://docs.business.blaaiz.com/api-reference/customer/register-owner-id-files.md): Register one or both of the owner's ID document slots (`id_document_front`, `id_document_back`). Each `file_id` must come from a fresh `POST /api/external/customer/{customer}/owner/{owner}/file/presigned-url` call. Send only the slots you want to set or replace. - [Delete a customer owner](https://docs.business.blaaiz.com/api-reference/customer/delete-a-customer-owner.md): Removes a beneficial owner from the customer. Returns 400 if the owner is locked (status APPROVED or PROCESSING). Required scope: `customer:write`. - [List beneficiaries](https://docs.business.blaaiz.com/api-reference/customer/list-beneficiaries.md): Retrieve all beneficiaries for a customer. Required scope: `beneficiary:read`. - [Get beneficiary](https://docs.business.blaaiz.com/api-reference/customer/get-beneficiary.md): Retrieve details of a specific beneficiary for a customer. Required scope: `beneficiary:read`. - [Register webhook URLs](https://docs.business.blaaiz.com/api-reference/webhook/register-webhook-urls.md): Register webhook URLs to receive event notifications. URLs must be HTTPS; Blaaiz signs requests via x-blaaiz-signature. Verify deliveries with your webhook signing_secret. Your collection_url receives collection events, virtual account events, and customer KYC events such as customer.created, custom… - [Get webhook URLs](https://docs.business.blaaiz.com/api-reference/webhook/get-webhook-urls.md): Retrieve your registered webhook URLs. Your collection_url is used for collection events, virtual account events, and customer KYC events. Required scope: `webhook:read`. - [Update webhook URL](https://docs.business.blaaiz.com/api-reference/webhook/update-webhook-url.md): Update your registered webhook URLs. Your collection_url receives collection events, virtual account events, and customer KYC events. Your optional kyc_url receives Merchant KYC verification session events; omit the field to leave it unchanged, or send null to clear it. Required scope: `webhook:writ… - [List webhook logs](https://docs.business.blaaiz.com/api-reference/webhook/list-webhook-logs.md): Get webhook delivery logs for your business. Crypto payout events use the `crypto.payout.*` type values. Required scope: `webhook:read`. - [Get a webhook log](https://docs.business.blaaiz.com/api-reference/webhook/get-a-webhook-log.md): Get one webhook delivery log. The response includes the related crypto transaction when the log is for a crypto payout. Required scope: `webhook:read`. - [Replay webhook](https://docs.business.blaaiz.com/api-reference/webhook/replay-webhook.md): Replay a webhook delivery. Send `transaction_id` for a successful fiat transaction. Send `webhook_log_id` for an eligible failed crypto payout webhook. Required scope: `webhook:replay`. - [Simulate Interac webhook (non-production)](https://docs.business.blaaiz.com/api-reference/webhook/simulate-interac-webhook-non-production.md): Sends a mock Interac collection webhook to your configured collection_url. Only available outside production; returns 400 in production. Required scope: `mock:webhook:trigger`. - [Merchant KYC overview](https://docs.business.blaaiz.com/compliance/overview.md): Verify the identity of your own customers with Blaaiz verification sessions. - [Quickstart — hosted verification](https://docs.business.blaaiz.com/compliance/quickstart-hosted.md): Create a verification session, send the verification link to your customer, and receive the result on your webhook. - [Quickstart — headless verification](https://docs.business.blaaiz.com/compliance/quickstart-headless.md): Upload identity documents and proof of address from your own server, then submit the session for review. - [Merchant KYC webhooks](https://docs.business.blaaiz.com/compliance/webhooks.md): Register your KYC webhook URL, read the session events, and verify the signature. - [Create a verification session](https://docs.business.blaaiz.com/api-reference/merchant-kyc/create-a-verification-session.md): Create a verification session for one person. The response normally returns status AWAITING_INPUT. A status of CREATED means the setup did not finish; repeat the call with the same idempotency_key. A repeat with the same idempotency_key returns the stored session. A repeat with the same key but a di… - [List verification sessions](https://docs.business.blaaiz.com/api-reference/merchant-kyc/list-verification-sessions.md): List the verification sessions of your business. The listing is always scoped to the business behind your access token. This endpoint stays available even when Merchant KYC is disabled for your business. Required scope: `compliance-kyc:read`. - [Get a verification session](https://docs.business.blaaiz.com/api-reference/merchant-kyc/get-a-verification-session.md): Get the current state of one verification session. Use it to poll a session, and to recover a result after a webhook delivery fails. A session that belongs to another business answers exactly like a session that does not exist. This endpoint stays available even when Merchant KYC is disabled for you… - [Create a document upload URL](https://docs.business.blaaiz.com/api-reference/merchant-kyc/create-a-document-upload-url.md): Get a presigned URL for one document, then send the file to it with an HTTP PUT, then register the file on the documents endpoint. Use this transport for every real document: a request body larger than about 8 KB is rejected at the network edge. The URL is valid for 5 minutes and the staged file mus… - [Upload a verification document](https://docs.business.blaaiz.com/api-reference/merchant-kyc/upload-a-verification-document.md): Add one document to a session. Send the bytes one of two ways, never both: file_name names a file you already staged through the upload-url endpoint, and content_base64 carries the bytes inline. Use file_name for every real document, because a request body larger than about 8 KB is rejected at the n… - [Submit a verification session for review](https://docs.business.blaaiz.com/api-reference/merchant-kyc/submit-a-verification-session-for-review.md): Send the session for review. The session moves to IN_REVIEW, stops accepting documents, and no longer expires. The request takes no body. Blaaiz refuses the submit when any step of the requirement set is still PENDING, when the session already left AWAITING_INPUT, and when the session is HOSTED. A s… - [Issue a verification link](https://docs.business.blaaiz.com/api-reference/merchant-kyc/issue-a-verification-link.md): Issue a new verification link for a HOSTED session. The create response already carries the first link, so call this endpoint only to replace a link that expired or leaked. Read link_expires_at for the new deadline. The previous link may stop working as soon as Blaaiz issues a new one. The link is a… - [Cancel a verification session](https://docs.business.blaaiz.com/api-reference/merchant-kyc/cancel-a-verification-session.md): Cancel a session that you no longer need. CANCELLED is terminal: Blaaiz sends no webhook for the session after a cancel, and the verification link stops working. A cancel frees a slot under your open session cap. A cancel on a session that is already terminal is refused with `422`: `This session has… - [Updates & improvements](https://docs.business.blaaiz.com/changelog.md): Release notes for Blaaiz docs and API. Follow along for new endpoints, UI polish, and integration guides. ## OpenAPI Specs - [token-openapi](/api-reference/auth/token-openapi.json) - [account-lookup-openapi](/api-reference/bank/account-lookup-openapi.json) - [iban-verification-openapi](/api-reference/bank/iban-verification-openapi.json) - [list-openapi](/api-reference/bank/list-openapi.json) - [payee-verification-openapi](/api-reference/bank/payee-verification-openapi.json) - [accept-interac-openapi](/api-reference/collection/accept-interac-openapi.json) - [attach-customer-openapi](/api-reference/collection/attach-customer-openapi.json) - [create-openapi](/api-reference/collection/create-openapi.json) - [get-crypto-networks-openapi](/api-reference/collection/get-crypto-networks-openapi.json) - [initiate-crypto-openapi](/api-reference/collection/initiate-crypto-openapi.json) - [initiate-interac-openapi](/api-reference/collection/initiate-interac-openapi.json) - [cancel-session-openapi](/api-reference/compliance-kyc/cancel-session-openapi.json) - [create-document-upload-url-openapi](/api-reference/compliance-kyc/create-document-upload-url-openapi.json) - [create-session-openapi](/api-reference/compliance-kyc/create-session-openapi.json) - [get-session-openapi](/api-reference/compliance-kyc/get-session-openapi.json) - [issue-verification-link-openapi](/api-reference/compliance-kyc/issue-verification-link-openapi.json) - [list-sessions-openapi](/api-reference/compliance-kyc/list-sessions-openapi.json) - [submit-session-openapi](/api-reference/compliance-kyc/submit-session-openapi.json) - [upload-document-openapi](/api-reference/compliance-kyc/upload-document-openapi.json) - [create-payout-openapi](/api-reference/crypto/create-payout-openapi.json) - [create-swap-openapi](/api-reference/crypto/create-swap-openapi.json) - [create-wallet-openapi](/api-reference/crypto/create-wallet-openapi.json) - [get-transaction-openapi](/api-reference/crypto/get-transaction-openapi.json) - [get-wallet-openapi](/api-reference/crypto/get-wallet-openapi.json) - [list-assets-openapi](/api-reference/crypto/list-assets-openapi.json) - [list-transactions-openapi](/api-reference/crypto/list-transactions-openapi.json) - [list-wallet-addresses-openapi](/api-reference/crypto/list-wallet-addresses-openapi.json) - [list-wallet-transactions-openapi](/api-reference/crypto/list-wallet-transactions-openapi.json) - [list-wallets-openapi](/api-reference/crypto/list-wallets-openapi.json) - [list-openapi](/api-reference/currency/list-openapi.json) - [add-kyc-openapi](/api-reference/customer/add-kyc-openapi.json) - [create-openapi](/api-reference/customer/create-openapi.json) - [delete-document-openapi](/api-reference/customer/delete-document-openapi.json) - [delete-owner-openapi](/api-reference/customer/delete-owner-openapi.json) - [get-beneficiary-openapi](/api-reference/customer/get-beneficiary-openapi.json) - [get-document-presigned-url-openapi](/api-reference/customer/get-document-presigned-url-openapi.json) - [get-openapi](/api-reference/customer/get-openapi.json) - [get-owner-file-presigned-url-openapi](/api-reference/customer/get-owner-file-presigned-url-openapi.json) - [list-beneficiaries-openapi](/api-reference/customer/list-beneficiaries-openapi.json) - [list-documents-openapi](/api-reference/customer/list-documents-openapi.json) - [list-openapi](/api-reference/customer/list-openapi.json) - [register-document-openapi](/api-reference/customer/register-document-openapi.json) - [show-document-openapi](/api-reference/customer/show-document-openapi.json) - [submit-openapi](/api-reference/customer/submit-openapi.json) - [update-document-openapi](/api-reference/customer/update-document-openapi.json) - [update-openapi](/api-reference/customer/update-openapi.json) - [upgrade-kyb-scope-openapi](/api-reference/customer/upgrade-kyb-scope-openapi.json) - [upload-files-openapi](/api-reference/customer/upload-files-openapi.json) - [upload-owner-files-openapi](/api-reference/customer/upload-owner-files-openapi.json) - [get-breakdown-openapi](/api-reference/fees/get-breakdown-openapi.json) - [create-openapi](/api-reference/file/create-openapi.json) - [create-openapi](/api-reference/interac-auto-deposit-email/create-openapi.json) - [get-openapi](/api-reference/interac-auto-deposit-email/get-openapi.json) - [list-openapi](/api-reference/interac-auto-deposit-email/list-openapi.json) - [simulate-webhook-interac-openapi](/api-reference/mock/simulate-webhook-interac-openapi.json) - [create-openapi](/api-reference/payout/create-openapi.json) - [list-openapi](/api-reference/rate/list-openapi.json) - [create-openapi](/api-reference/refund/create-openapi.json) - [get-openapi](/api-reference/refund/get-openapi.json) - [create-openapi](/api-reference/swap/create-openapi.json) - [get-openapi](/api-reference/transaction/get-openapi.json) - [list-openapi](/api-reference/transaction/list-openapi.json) - [close-openapi](/api-reference/virtual-bank-account/close-openapi.json) - [create-openapi](/api-reference/virtual-bank-account/create-openapi.json) - [get-identification-type-openapi](/api-reference/virtual-bank-account/get-identification-type-openapi.json) - [get-openapi](/api-reference/virtual-bank-account/get-openapi.json) - [list-openapi](/api-reference/virtual-bank-account/list-openapi.json) - [get-openapi](/api-reference/wallet/get-openapi.json) - [list-openapi](/api-reference/wallet/list-openapi.json) - [get-log-openapi](/api-reference/webhook/get-log-openapi.json) - [get-openapi](/api-reference/webhook/get-openapi.json) - [list-logs-openapi](/api-reference/webhook/list-logs-openapi.json) - [register-openapi](/api-reference/webhook/register-openapi.json) - [replay-openapi](/api-reference/webhook/replay-openapi.json) - [update-openapi](/api-reference/webhook/update-openapi.json) ## Optional - [Dashboard](https://business.blaaiz.com) - [Support](mailto:support@blaaiz.com)