Global Payee Verification (G-PV) - Validate beneficiary details globally

post

https://masspaysandbox.api.convera.com/masspayments/banks/{customerId}/globalvalidate

Performs Global Payee Verification (G-PV) for beneficiary details across multiple countries. Supports GB (COP with IBAN or localAccountNumber+sortCode), AU (localAccountNumber+sortCode), and IBAN-based countries (AT, DE, etc.). Returns per-beneficiary validation results including match scores and validation status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

customerId

Body Params

Global Payee Verification (G-PV) validation request data

Global VOP V2 validation request. Validates beneficiary details across supported countries (GB, AU, AT, DE, etc.).

beneficiaryDetails

array of objects

required

length ≥ 1

Array of beneficiary details to validate

beneficiaryDetails*

Individual beneficiary details for validation. Requires either iban OR localAccountNumber+sortCode. accountHolderType is required for GB and AU only.

countryCode

string

required

ISO 3166-1 alpha-2 country code of the beneficiary's bank account

creditorName

string

required

Name of the account holder to validate against

iban

string

International Bank Account Number. Required if localAccountNumber and sortCode are not provided.

localAccountNumber

string

Local bank account number. Must be used together with sortCode. Alternative to iban.

sortCode

string

Bank sort code / routing number. Must be used together with localAccountNumber.

creditorBic

string

BIC/SWIFT code of the creditor's bank. Optional for COP (GB), may be required for SWIFT path.

accountHolderType

string

enum

Type of account holder. Required for GB and AU (COP countries). Values: personal, business.

Allowed:

postalAddress

object

Postal address of the beneficiary. Optional for most validations.

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200Validation completed. Response structure varies based on outcome.

400BadRequest - Only returned when requestReferenceId is missing or invalid

401Unauthorized

500Internal Server Error