Skip to main content
POST
Create Verification

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
required

Type of beneficiary entity.

Available options:
individual,
business
beneficiary_details
object
required

Inline payee details (Mode B). Required on the wire, but auto-populated when beneficiary is passed.

beneficiary
string

ID of an existing saved beneficiary (bnf_xxxx) to verify (Mode A). When provided, name, type, and beneficiary_details are resolved from the saved beneficiary and any values you pass for them are overwritten.

name
string

Full name of the beneficiary (payee) to match against the account holder. Required for Mode B (inline) requests.

metadata
object

Additional key-value data to attach to the verification. Echoed back in the response.

Response

200