> ## Documentation Index
> Fetch the complete documentation index at: https://docs.business.blaaiz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API parameters

> Common parameters used across Blaaiz API endpoints

## Request parameters

While interacting with our API, you may encounter specific parameters in the request body for various endpoints. Below are key parameters and their possible values.

### Method

The `method` parameter appears in the **Payout API** when initiating a payout. It represents the channel through which the money will be sent.

* `bank_transfer` – Sends the payout via bank transfer (available for NGN, GBP, EUR transactions).
* `interac` – Sends the payout using Interac (available for CAD transactions).
* `ach` - Sends the payout using ACH (available for USD transactions).
* `wire` - Sends the payout using Wire (available for USD transactions).
* `crypto` - Sends the payout using Crypto (available for USD transactions).

Use either of these values depending on which provider you want to use for the payout process.

For the **Collection API**, the currently documented value is:

* `card` - Creates a card collection request for a business wallet.

### File category

The `file_category` parameter appears in the **File API** when requesting a pre-signed URL for upload. It represents the type of file you want to upload, **for individual customers only**.

<Warning>
  The File API and `file_category` apply to **individual customers** (`type=individual`) only. For `type=business` customers, use the dedicated KYB upload endpoints — see [Business customer KYB](/guides/kyb/overview). Calling the File API for a business customer does not trigger verification.
</Warning>

* `identity` – Identity document. **Required** to verify an individual customer. Must be a **Driver's License**, **Passport**, or **Resident Permit**. **ID cards (National Identity Cards) are not accepted.** No other document types are supported at this category.
* `identity_back` – Back side of the identity document. Use this when the identity document is two-sided (e.g. driver's license). Not required for single-sided documents (e.g. passport).
* `proof_of_address` – Proof of address.
* `liveness_check` – Liveness check.

<Warning>
  All uploaded documents must be **clear, legible, and authentic**. Blurry, cropped, obscured, or otherwise unclear images will not be reviewed and will be rejected. Fraudulent or falsified documents will not be tolerated — repeated attempts to submit false or invalid documents will result in the customer being **permanently blacklisted** from the platform. There are no exceptions or compromises.
</Warning>

### Id type

The `id_type` parameter appears in the **Customer API** when creating or updating a customer.

**For individual customers**, `id_type` is required at create time. Only the following are accepted:

* `drivers_license` – Driver's License.
* `passport` – Passport.
* `resident_permit` – Resident Permit.

**For business customers**, `id_type` and `id_number` are **prohibited** — sending either returns `422`. Businesses identify via `registration_number` + `incorporation_country`. The actual certificate of incorporation goes into the KYB document collection (`type=CERTIFICATE_OF_INCORPORATION`), not through the File API. See [Business customer KYB](/guides/kyb/overview).

<Warning>
  No other identity document types are accepted at the customer level. **ID cards (National Identity Cards) are not accepted.** Individual customers must provide a Driver's License, Passport, or Resident Permit. Business customers do not need to provide a customer-level identity document.
</Warning>

<Warning>
  All uploaded documents must be **clear, legible, and authentic**. Blurry, cropped, obscured, or otherwise unclear images will not be reviewed and will be rejected. Fraudulent or falsified documents will not be tolerated — repeated attempts to submit false or invalid documents will result in the customer being **permanently blacklisted** from the platform. There are no exceptions or compromises.
</Warning>

### Customer type

The `type` parameter appears in the **Customer API** when creating a new customer. It represents the type of customer to be created, i.e. individual or business.

* `individual` – Individual.
* `business` – Business.

### TIN

The `tin` parameter appears in the **Customer API** for countries and customer types where a tax identification field is required.

* Do not hardcode the label shown to your users.
* Use the [Get identification type](/api-reference/virtual-bank-account/get-identification-type) endpoint to retrieve the correct country-specific label or field before collecting the value.
