---
title: "Fetch Beneficiary"
method: GET
path: "/v3/beneficiary/{id}"
---

# Fetch Beneficiary

`GET /v3/beneficiary/{id}`

This lets you fetch an existing beneficiary

## Path parameters

- `id` string, required

## Response `200`

200

- object — Represents a payout beneficiary with personal, contact, and destination details.
  - `address` Address — Address details
    - `line1` string — Address Line 1
    - `line2` string — Address Line 2
    - `city` string — Address city
    - `state` string — Address state
    - `country` string — Address country (ISO 3166-1 alpha-2 country code)
    - `postal_code` string — Postal Code
  - `date_of_birth` string — Date of birth of the beneficiary in YYYY-MM-DD format.
  - `nationality` string — ISO 3166-1 alpha-2 country code representing the beneficiary's nationality. Optional field used for enhanced compliance screening. Sending this field will reduce compliance hold.
  - `destination` string — Identifier or reference to the beneficiary's payment destination (bank account, wallet, etc.).
  - `destination_details` DestinationDetails — Destination details for beneficiary payouts (discriminated union based on type)
    - `type` 'bank' | 'wallet' | 'local_payment_network' | 'tazapay_account', required — Type of destination
    - `bank` Bank — Bank account details
      - `account_number` string — Bank Account Number. Either account_number or IBAN is mandatory
      - `iban` string — IBAN. Either account_number or iban is mandatory
      - `bank_name` string — Name of the bank
      - `branch_name` string — Name of the branch
      - `country` string — Two-letter country code (ISO 3166-1 alpha-2)
      - `currency` string — Three-letter ISO currency code, in uppercase
      - `purpose_code` string — Purpose Code for INR bank accounts
      - `bank_codes` BankCodes — Bank specific identification codes
        - `swift_code` string — SWIFT Code
        - `bic_code` string — Bank Identifier Code (BIC)
        - `ifsc_code` string — IFS Code
        - `aba_code` string — ABA / Routing Number
        - `sort_code` string — SORT Code
        - `branch_code` string — Branch Code
        - `bsb_code` string — BSB Code
        - `bank_code` string — Bank Code
        - `cnaps` string — CNAPS
      - `firc_required` boolean — Pass true if you want FIRC for a payout to India
      - `account_type` 'savings' | 'checking' | 'payment' — Type of bank account
      - `account_holder_name` string — Name of the account holder
      - `transfer_type` string — Type of transfer (e.g., local, SWIFT)
    - `wallet` Wallet — Crypto wallet destination details
      - `deposit_address` string, required — Blockchain wallet address
      - `type` 'ethereum' | 'tron' | 'polygon' | 'solana' | 'bitcoin_lightning_network', required — Type of blockchain wallet (e.g., ethereum, bitcoin_lightning_network). Use `bitcoin_lightning_network` for BTC currency only.
      - `currency` string, required — Cryptocurrency code (e.g., USDC, BTC, ETH)
      - `hosted` 'yes' | 'no' — Whether wallet is hosted/custodial
      - `vasp_name` string — Virtual Asset Service Provider name (required for hosted wallets)
      - `vasp_website` string — VASP website URL (required for hosted wallets)
    - `local_payment_network` LocalPaymentNetwork — Local payment network destination details (e.g., PIX, UPI, PromptPay)
      - `type` string, required — Type of local payment network (e.g., pix_brl, upi_inr, promptpay_thb)
      - `deposit_key_type` string — Type of the deposit key (conditionally mandatory depending on network type)
      - `deposit_key` string, required — Deposit key for the local payment network (e.g., PIX key, UPI handle)
      - `currency` string — Currency code for the local payment network
    - `tazapay_account` TazapayAccount — Tazapay account destination details
      - `deposit_address` string, required — Tazapay account deposit address (format - xxxxx@tzp)
  - `documents` object[] — List of documents associated with the beneficiary (e.g., ID proof, address proof).
  - `email` string — Email address of the beneficiary.
  - `name` string — Full name of the beneficiary.
  - `name_local` string — Local language representation of the beneficiary's name, if applicable.
  - `national_identification_number` string — National identification number or equivalent ID.
  - `party_classification` string — Classification of the beneficiary. Possible Values - 'self', 'third_party'.
  - `phone` Phone — Phone contact details
    - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India)
    - `number` string — Phone Number
  - `registration_number` string — Registration or incorporation number for business beneficiaries.
  - `tax_id` string — Tax identification number for the beneficiary.
  - `type` string — Specifies whether the beneficiary is an 'individual' or a 'business'.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/tazapay/apis/sandbox.md) · [All operations](https://skmtc.net/tazapay/apis/sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tazapay/sandbox/revisions/bf5f4b8f6f5d/schema)
