Skip to main content
POST
Run a standalone Verification of Payee check for a list of beneficiaries
Runs a standalone Verification of Payee check for the given Beneficiaries list. The beneficiary data can be provided with beneficiary_id + account_id combination, or with beneficiary_name + iban + swift_code combination. The result’s authorization_id can be used in a following Payment request as vop_authorization_id queryparam, as long as the beneficiary information in the VoP check request and the payment request are the same.

Authorizations

x-api-key
string
header
required

An API Key.

Query Parameters

client_id
string
required

The ID of the client

Body

application/json
beneficiaries
object[]
required

List of beneficiaries to check.

Response

The Verification of Payee outcome with a list of results, one for each provided beneficiary dataset.

The details of a Verification of Payee check.

authorization_id
string

The ID of the VoP check. Can be provided in payment requests as vop_authorization_id queryparam to confirm VoP checks.

results
object[]

The list of VoP results, one for each beneficiary data object provided.

status
string

Summary of the VoP status of the whole batch. It is the highest priority status of all the results.