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.
This feature is coming soon. The APIs listed here are for reference only
and are not yet available in production or sandbox.
curl --request POST \ --url https://service-sandbox.tazapay.com/v3/verify/payee \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data '{ "name": "John Doe", "type": "individual", "beneficiary_details": { "destination_details": { "type": "bank", "bank": { "account_number": "9876543210", "bank_codes": { "ifsc_code": "HDFC0001234" }, "country": "IN", "currency": "INR" } } }, "reference_id": "your-internal-ref-001" }'
{ "status" : "success" , "message" : "" , "data" : { "id" : "ver_xxxx" , "object" : "verification" , "verification_status" : "pending" , "status_description" : "" , "beneficiary" : null , "beneficiary_details" : { "type" : "individual" , "address" : null , "phone" : null , "tax_id" : null , "destination" : null }, "destination_details" : { "type" : "bank" , "local_payment_network" : null }, "verified_information" : null , "balance" : { "holding_currency" : "USD" , "initial_balance" : 100 , "balance_impact" : 10 , "balance_remaining" : 90 , "balance_transaction_id" : "txn_xxxx" }, "metadata" : null , "reference_id" : "your-internal-ref-001" , "created_at" : "2026-04-07T10:00:00Z" , "updated_at" : "2026-04-07T10:00:00Z" } }
Initiate Verification POST /v3/verify/payee
Pass exactly one of beneficiary (Mode A — saved beneficiary) or
beneficiary_details (Mode B — inline). Use
Get Verification Metadata
to determine which fields and bank codes are required for a given corridor.
Authorizations Basic authentication header of the form Basic <encoded-value>, where
<encoded-value> is the base64-encoded string username:password.
Body Full name of the beneficiary (payee) to match against the account holder.
Type of beneficiary entity. Allowed: individual, business.
ID of an existing saved beneficiary (bnf_xxxx). If provided, inline
beneficiary fields (name, destination_details, etc.) are not required.
Pass this or beneficiary_details, not both.
Inline payee details. Pass this or beneficiary, not both. Email address of the beneficiary.
First line of the street address.
Second line of the street address.
State or province of the beneficiary.
Country of the address (ISO 3166-1 alpha-2).
Phone number of the beneficiary.
International dialing code (e.g. +91 for India).
Container object holding payout destination details. Type of payout destination. Allowed: bank, wallet,
local_payment_network.
Required when destination_details.type = bank. Bank account number of the beneficiary.
IBAN of the beneficiary. Required for IBAN corridors.
Name of the beneficiary’s bank.
Name or identifier of the bank branch.
Country where the bank account is held (ISO 3166-1 alpha-2).
Currency of the bank account (ISO 4217).
Container for bank routing identifiers. Which codes are required
depends on the corridor — use
Get Verification Metadata
to check. SWIFT/BIC code of the bank.
IFSC code for Indian bank accounts.
ABA routing number for US bank accounts.
Sort code for UK bank accounts.
Branch-level identifier used in specific corridors where IFSC, SWIFT, or other routing codes are insufficient. Format varies by country and bank.
BSB code for Australian bank accounts.
Bank code used in specific corridors.
CNAPS code for Chinese bank accounts.
Type of bank account (e.g. savings, current, checking).
Required when destination_details.type = local_payment_network. Show local_payment_network
Type of local payment network (e.g. upi_inr, pix_brl,
promptpay_thb).
Deposit key for the network (e.g. UPI handle, PIX key).
Type of deposit key. Conditionally required depending on
network type.
Tax identification number of the beneficiary.
Name of the beneficiary in local language or script.
Additional key-value data. Max 10 keys; string values ≤ 500 chars each.
Reference ID of the verification on your system. Echoed in the response.
Response Unique identifier for the verification object. Prefix: ver_.
Fixed value: verification.
Current status of the verification. Allowed: valid, invalid,
pending, not_supported.
Human-readable description of the verification status.
ID of the saved beneficiary used (bnf_xxxx). null for inline
(Mode B) verifications.
Echo of the beneficiary details submitted in the request or retrieved
from the saved beneficiary object. Type of beneficiary entity (individual or business).
Country of the beneficiary (ISO 3166-1 alpha-2).
First line of the street address.
Second line of the street address.
State or province of the beneficiary.
International dialing code (e.g. +91 for India).
Phone number of the beneficiary.
Tax identification number of the beneficiary.
ID of the destination object associated with this beneficiary. null
if inline destination_details were passed.
Destination details echoed from the request. Type of payout destination (e.g. bank, local_payment_network).
Present when destination_details.type = local_payment_network. Show local_payment_network
Type of local payment network (e.g. pix_brl, upi_inr).
Deposit key for the network.
Provider-returned verification result. Present when
verification_status.status = valid. Show verified_information
Scoring methodology used by the provider (e.g. continuous, discrete).
Normalised confidence score from 0 to 1 as returned by the provider.
Tazapay normalised match classification. Allowed: strong_match, partial_match, no_match.
Translation of the matched name in local script, if available.
Corrected or suggested name returned by the provider where a close but imperfect match was found.
Indicates whether the account was found and recognised at the bank.
Whether the account belongs to an individual or business.
Bank account number of the beneficiary.
Type of bank account (e.g. savings, current, checking).
SWIFT/BIC code of the bank.
ABA routing number of the bank.
Name of the beneficiary’s bank.
Name or identifier of the bank branch.
Address of the beneficiary’s bank as returned by the provider.
Country where the bank account is held (ISO 3166-1 alpha-2).
Currency of the bank account (ISO 4217).
payment_scheme_eligibility
Payment schemes the account is eligible for. Applicable to IBAN corridors only (e.g. SEPA Credit Transfer, SEPA Instant).
transaction_activity_details
Transaction activity details returned by the provider (Kinexys only). Show transaction_activity_details
Indicates whether recent transaction activity was detected on the account.
transaction_activity_since
Date from which transaction activity was checked.
Balance snapshot at the time of this verification. Currency from which the merchant is charged for this verification.
Either USD or the merchant’s primary currency, depending on which
is utilised.
Balance of the holding currency before this deduction.
Amount consumed for this verification.
Balance of the holding currency remaining after this deduction.
Transaction ID of the balance debit entry.
Key-value map of merchant-defined metadata. Echoed from the request if
provided. Max 10 keys; string values ≤ 500 chars each.
Your reference ID echoed from the request.
Timestamp when the verification object was created.
Timestamp of the last status update.
