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": … }. You get back whether it matched.

Reading the result

A close-but-not-exact match still returns match: true with the real name in name — show it to the user so they can decide whether to continue.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. 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 }.

Response

Verification result

success
boolean
Example:

true

data
object