Verifies a payee using VoP or CoP.

Authorization: API key (HMAC signed and IP address whitelisted) is required.

Body Params

The payee to verify.

string
required
length ≥ 1

The name of the account to verify

string
required
length ≥ 1

The IBAN of the account to verify (for VoP checks)

string | null

The sort code of the account to verify (for CoP checks)

string | null

The account number of the account to verify (for CoP checks)

string | null

Optional secondary identifier for the account to verify. It is usually the reason why the payment is being made or what invoice or obligation it relates to. Some responders may require this where just the identifier is not sufficient to uniquely identify the account.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json