Skip to main content

​
Beneficiary

​
Object Structure

{
  "address": {
        "city": "Vijay",
        "country": "IN",
        "line1": "street 30th",
        "postal_code": "110018",
        "state": "Delhi"
      },
  "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": "[email protected]",
  "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",
  "is_doc_verification_required": true,
  "status": "active",
  "verification_status": "succeeded"
}

​
Beneficiary Details

FieldTypeDescription
idstringThe unique Tazapay identifier for the beneficiary.
addressobjectThe address of the beneficiary. Address Object
date_of_birthstringDate of birth of the beneficiary (for individuals).
nationalitystringISO 3166-1 alpha-2 country code representing the beneficiary’s nationality (e.g., US, GB, IN, FR). Optional field used for enhanced compliance screening.
destinationstringThe destination identifier (if applicable).
destination_detailsobjectThe details of the destination account. (Destination Details Object)
documentsarrayThe list of documents related to the beneficiary.
emailstringThe email address of the beneficiary.
namestringThe name of the beneficiary.
name_localstringThe local language name of the beneficiary.
national_identification_numberstringThe national ID number of the beneficiary.
party_classificationenumClassification of the beneficiary (Possible values - self, third_party).
phoneobjectThe phone details of the beneficiary. (Phone Object)
registration_numberstringThe registration number (for business beneficiaries).
tax_idstringThe tax identification number of the beneficiary.
created_atstring (ISO timestamp)The date and time when the beneficiary was created.
metadatajsonAdditional key-value pairs associated with the beneficiary (optional).
is_doc_verification_requiredbooleanIndicates if document verification is required for this beneficiary. Applicable for wallet beneficiaries.
statusenumCurrent status of the beneficiary. Possible values: active, inactive
verification_statusenumDocument verification status for wallet beneficiaries. Possible values: processing, requires_action, succeeded, failed

​
Destination Details

​
Object Structure

{
  "type": "wallet",
    "wallet": {
            "currency": "USDC",
            "deposit_address": "09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8",
             "type": "ethereum",
             "hosted": "yes",
             "vasp_name": "Binance",
             "vasp_website": "https://www.binance.com"
    }
}

​
Object Parameters

​
Bank

SubfieldTypeDescription
account_numberstringThe account number of the beneficiary’s bank.
account_typeenumThe type of bank account. Enum value - savings, checking, payment
bank_codesobjectThe bank codes (ABA / SWIFT).
bank_namestringThe name of the beneficiary’s bank.
branch_namestringThe branch name of the beneficiary’s bank.
countrystringThe country of the beneficiary’s bank.
currencystringThe currency in which the bank account operates.
firc_requiredbooleanWhether FIRC is required.
purpose_codestringThe purpose code for the bank transfer.
transfer_typeenumThe transfer type (values - swift, local, any).
ibanstringThe IBAN of the beneficiary’s bank account.

​
Wallet

SubfieldTypeDescription
currencystringThe cryptocurrency type (e.g., USDC).
deposit_addressstringThe wallet deposit address.
typeenumThe blockchain type. [Values: ethereum, tron, polygon, solana]
hostedenumIndicates 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_namestringThe 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_websitestringThe 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

SubfieldTypeDescription
currencystringThe currency used in the local payment network.
deposit_keystringThe deposit key corresponding to the type of local payment network (e.g., PIX key, UPI handle).
deposit_key_typeenumType of the deposit key. Conditionally mandatory depending on the value of type
typeenumThe local payment network type. [Values: pix_brl, upi_inr, promptpay_thb]

​
Tazapay Account

SubfieldTypeDescription
deposit_addressstringThe Tazapay account deposit address.