POST
Verify a payee's name
Before you save or pay someone, check that the name they gave you actually matches the account — this is Confirmation of Payee (UK) / Verification of Payee (EU). It helps catch typos and scams. Send the name to check and the account as a discriminated account object — { "type": "uk", "sortCode": …, "accountNumber": … } or { "type": "iban", "iban": …, "bic": … }.
  • IBAN: send the payee’s bic. It must belong to the IBAN’s bank.
  • UK business payee: send beneficiary.isCorporate: true, so the name is checked against a business account. Without it the check assumes a personal account.

Reading the result

Drive what you show from outcome:
A scheme code Orenda doesn’t recognise comes back as UNAVAILABLE, never as a match.
A 400 means the request itself was refused: the body is malformed, or bic is missing, malformed or belongs to another bank than the IBAN’s. A 422 (NAME_VERIFICATION_API_ERROR) means the check couldn’t run; treat it like UNAVAILABLE.

Test payees in sandbox

Sandbox runs no real check: the payee name picks the outcome. Names match ignoring case. Jane Doe on any other account is a MATCH.

Authorizations

Authorization
string
header
required

The user's access_token from authentication. The program and environment come from the token.

Body

application/json
beneficiary
object
required
account
UK · object
required

The account to check. For UK use { type: "uk", sortCode, accountNumber }; for EU { type: "iban", iban, bic }. Send bic with every IBAN; it must belong to the IBAN's bank.

Response

Verification result

success
boolean
Example:

true

message
string

What happened, for display.

data
object