Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Verification of Payee

Create Verification of Payee (VOP) request

This endpoint allows you to get information on the accuracy of the payee details the user is going to send a payment to.

post/verify-payee

Request body

namestring required

The name of the payee.

ibanstring required

The IBAN of the payee.

paymentAccountIdstring required

The bid of the account the payment will be initiated from.

customerIdstring

The bid of the customer that is making this request.

Example request

{
  "name": "John Smith",
  "iban": "AD1200012030200359100100",
  "paymentAccountId": "A123AAA4",
  "customerId": "C1100001"
}

Response

Ok

idstring required

Unique id of verify payee request.

Example response

{
  "id": "PAV0000001",
  "result": {
    "code": "MATCH",
    "matchedName": "Joseph Bloggs"
  }
}