Skip to main content
This feature 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

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

Body

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

Response

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