Run a Confirmation-of-Payee check on a GBP account. Blaaiz returns a match or no-match result and never returns the real account name. Required scope: bank:read.
Authorization
oauth2ClientCredentials bank:readUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: bank:read
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
This endpoint runs a UK Confirmation-of-Payee (CoP) check on a GBP bank account. You send the sort code, the account number, and the name that you expect for the account. Blaaiz returns a match or no-match result. It does not return the real account holder name. Use this endpoint to confirm payee details before you send a GBP payout. Example Use Cases:
- Confirm that a payee name matches the account before a GBP transfer.
- Detect a close name match and show the suggested name to the user.
- Reduce misdirected payments and payment fraud.
Response Body
application/json
application/json
application/json
application/json
curl --request POST \ --url 'https://example.com/api/external/bank/payee-verification' \ --header 'Content-Type: application/json' \ --data '{ "sort_code": "20-00-00", "account_number": "12345678", "account_name": "Jane Doe"}'{ "matched": true, "match_confidence_code": null, "suggested_account_name": null}