> ## Documentation Index
> Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Beneficiary
> The Tazapay Beneficiary Object represents the recipient of a payment or payout within the Tazapay platform. This object holds all relevant information about the beneficiary, including personal details, bank account information, and any other relevant metadata required for processing payments to them.
## Beneficiary
## Object Structure
```json Individual expandable theme={null}
{
"address": {
"city": "Kingston",
"country": "JM",
"line1": "12 Hope Road",
"postal_code": "00010",
"state": "Kingston"
},
"date_of_birth": "2003-04-04",
"nationality": "IN",
"destination": "wal_d3inm6ami8u10oqfk",
"destination_details": {
"type": "wallet",
"wallet": {
"currency": "USDC",
"deposit_address": "09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8",
"type": "ethereum",
"hosted": "no"
}
},
"documents": [],
"email": "abc@gmail.com",
"name": "Scott",
"name_local": "स्कॉट",
"national_identification_number": "AIDPK1234M",
"party_classification": "third_party",
"phone": {
"calling_code": "91",
"number": "9231231231"
},
"registration_number": "",
"tax_id": "29ABCDE1234F1Z5",
"type": "individual",
"status": "active"
}
```
```json Business expandable theme={null}
{
"address": {
"city": "Vrtmore",
"country": "JM",
"line1": "it12 3cwth",
"postal_code": "00000",
"state": "Vortmore"
},
"destination": "bnk_d05lmjuq59csbboqt9d0",
"destination_details": {
"bank": {
"account_number": "DE535019045650474185",
"account_type": "savings",
"bank_codes": {
"swift_code": "FBDEFF"
},
"bank_name": "ER VOLKSBANK EG",
"branch_name": "Frankfurt am Main",
"country": "DE",
"currency": "EUR",
"firc_required": false,
"iban": "DE535019045650474185",
"purpose_code": "",
"transfer_type": "any"
},
"type": "bank"
},
"documents": [],
"email": "finance@gmbh-company.de",
"nationality": "DE",
"name": "GMBH",
"name_local": "",
"national_identification_number": "",
"party_classification": "third_party",
"phone": {
"calling_code": "49",
"number": "9231231231"
},
"registration_number": "HRB 123456",
"tax_id": "DE123456789",
"type": "business",
"status": "active"
}
```
#### Beneficiary Details
| Field | Type | Description |
| :------------------------------- | :--------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | The unique Tazapay identifier for the beneficiary. |
| address | object | The address of the beneficiary. [**Address Object**](/update/reference/address-object#/) |
| date\_of\_birth | string | Date of birth of the beneficiary (for individuals). |
| nationality | string | ISO 3166-1 alpha-2 country code representing the beneficiary's nationality (e.g., US, GB, IN, FR). Optional field used for enhanced compliance screening. |
| destination | string | The destination identifier (if applicable). |
| destination\_details | object | The details of the destination account. ([**Destination Details Object**](/update/reference/destination-deatils-object/)) |
| documents | array | The list of documents related to the beneficiary. |
| email | string | The email address of the beneficiary. |
| name | string | The name of the beneficiary. Maximum 140 characters. |
| name\_local | string | The local language name of the beneficiary. |
| national\_identification\_number | string | The national ID number of the beneficiary. |
| party\_classification | enum | Classification of the beneficiary (Possible values - `self`, `third_party`). |
| phone | object | The phone details of the beneficiary. ([**Phone Object**](/update/reference/phone-object/)) Mandatory when beneficiary country is China (CN). Must be a valid Chinese mobile number: 11 digits, regex `^(\+86)?1[3-9]\d{9}$`. Country code `+86` is auto-prefixed. |
| registration\_number | string | The registration number (for business beneficiaries). |
| tax\_id | string | The tax identification number of the beneficiary. |
| created\_at | string (ISO timestamp) | The date and time when the beneficiary was created. |
| metadata | json | Additional key-value pairs associated with the beneficiary (optional). |
| status | enum | Current status of the beneficiary. Possible values: `active`, `inactive` |
## Destination Details
### Object Structure
```json Wallet theme={null}
{
"type": "wallet",
"wallet": {
"currency": "USDC",
"deposit_address": "09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8",
"type": "ethereum",
"hosted": "yes",
"vasp_name": "Binance",
"vasp_website": "https://www.binance.com"
}
}
```
```json Bitcoin Lightning Network theme={null}
{
"type": "wallet",
"wallet": {
"currency": "BTC",
"deposit_address": "lnbc1500n1pje3xdapp...",
"type": "bitcoin_lightning_network",
"hosted": "no"
}
}
```
```json Bank theme={null}
{
"bank": {
"account_number": "DE535019045650474185",
"account_type": "savings",
"bank_codes": {
"swift_code": "FBDEFF"
},
"bank_name": "ER VOLKSBANK EG",
"branch_name": "Frankfurt am Main",
"country": "DE",
"currency": "EUR",
"firc_required": false,
"iban": "DE535019045650474185",
"purpose_code": "",
"transfer_type": "any"
},
"type": "bank"}
```
```json Local Payment Network theme={null}
{
"local_payment_network": {
"currency": "BRL",
"deposit_key": "fep@gmail.com",
"deposit_key_type": "email",
"type": "pix_brl"
},
"type": "local_payment_network"
}
```
```json Tazapay Account theme={null}
{
"tazapay_account": {
"deposit_address": "ce4f51ue@tzp"
},
"type": "tazapay_account"
}
```
## Object Parameters
### Bank
| Subfield | Type | Description |
| :-------------- | :------ | :---------------------------------------------------------------------- |
| account\_number | string | The account number of the beneficiary's bank. |
| account\_type | enum | The type of bank account. Enum value - `savings`, `checking`, `payment` |
| bank\_codes | object | The bank codes (ABA / SWIFT). |
| bank\_name | string | The name of the beneficiary’s bank. |
| branch\_name | string | The branch name of the beneficiary’s bank. |
| country | string | The country of the beneficiary’s bank. |
| currency | string | The currency in which the bank account operates. |
| firc\_required | boolean | Whether FIRC is required. |
| purpose\_code | string | The purpose code for the bank transfer. |
| transfer\_type | enum | The transfer type (values - `swift`, `local`, `any`). |
| iban | string | The IBAN of the beneficiary’s bank account. |
### Wallet
| Subfield | Type | Description |
| :--------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| currency | string | The cryptocurrency type (e.g., `USDC`). |
| deposit\_address | string | The wallet deposit address. |
| type | enum | The blockchain type. \[Values: `ethereum`, `tron`, `polygon`, `solana`, `bitcoin_lightning_network`]. Use `bitcoin_lightning_network` for BTC currency only. |
| hosted | enum | Indicates whether the wallet is custodial (hosted) or non-custodial (unhosted). Possible values: `yes` – The wallet is hosted by a Virtual Asset Service Provider (VASP) or exchange. `no` – The wallet is non-custodial and controlled directly by the user (e.g., MetaMask, Ledger). Mandatory if `party_classification` is 'self' and `destination_details.type` is 'wallet'. |
| vasp\_name | string | The registered name of the Virtual Asset Service Provider (VASP) or exchange that hosts or manages the wallet. Mandatory if `party_classification` is 'self', `destination_details.type` is 'wallet' and `hosted` is 'yes' |
| vasp\_website | string | The official website URL of the VASP or exchange that manages the wallet. Used for VASP identification and due diligence under Travel Rule requirements. Mandatory if `party_classification` is 'self', `destination_details.type` is 'wallet' and `hosted` is 'yes' |
### Local Payment Network
| Subfield | Type | Description |
| :----------------- | :----- | :---------------------------------------------------------------------------------------------- |
| currency | string | The currency used in the local payment network. |
| deposit\_key | string | The deposit key corresponding to the type of local payment network (e.g., PIX key, UPI handle). |
| deposit\_key\_type | enum | Type of the deposit key. Conditionally mandatory depending on the value of type |
| type | enum | The local payment network type. \[Values: `pix_brl`, `upi_inr`, `promptpay_thb`] |
### Tazapay Account
| Subfield | Type | Description |
| ---------------- | ------ | ------------------------------------ |
| deposit\_address | string | The Tazapay account deposit address. |