Skip to main content
Tazamatch is coming soon. The APIs listed here are for reference only and are not yet available in production or sandbox.
cURL
200

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

Authorization
string
required
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

name
string
required
Full name of the beneficiary (payee) to match against the account holder.
type
enum
required
Type of beneficiary entity. Allowed: individual, business.
beneficiary
string
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.
beneficiary_details
object
Inline payee details. Pass this or beneficiary, not both.
metadata
object
Additional key-value data. Max 10 keys; string values ≤ 500 chars each.
reference_id
string
Reference ID of the verification on your system. Echoed in the response.

Response

id
string
Unique identifier for the verification object. Prefix: pyv_.
object
string
Fixed value: verification.
verification_status
enum
Current status of the verification. Allowed: valid, invalid, pending, not_supported.
status_description
string
Human-readable description of the verification status.
beneficiary
string
ID of the saved beneficiary used (bnf_xxxx). Empty string for inline (Mode B) verifications.
beneficiary_details
object
Echo of the beneficiary details submitted in the request or retrieved from the saved beneficiary object.
verified_information
object
Verification result. Present when verification_status = valid. null for not_supported.
balance
object
Balance snapshot at the time of this verification. null when verification_status = not_supported as no charge is applied.
metadata
object
Key-value map of merchant-defined metadata. Echoed from the request if provided. Max 10 keys; string values ≤ 500 chars each.
reference_id
string
Your reference ID echoed from the request.
created_at
timestamp
Timestamp when the verification object was created.
updated_at
timestamp
Timestamp of the last status update.