v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Confirmation of Payee

Create an account name check

This endpoint allows you to check the account details of a payee with their bank before you create a beneficiary or payment. If the account details are confirmed, you will have greater assurance that a payment you create will reach the correct bank account. This endpoint does not support idempotent requests. Any requests containing an x-mod-nonce header used by a previous request will return the response <code>403: Forbidden ("Unique/allowed nonce header not found")</code>

post/account-name-check

Request body

paymentAccountIdstring required

The identifier of the account that a subsequent payment will be initiated from.

sortCodestring required

The sort code of the account.

accountNumberstring required

The account number.

secondaryAccountIdstring

Additional information used in conjunction with the Sort Code and Account Number to identify the account (such as a Building Society roll number).

accountType'PERSONAL' | 'BUSINESS' required

The type of account, either a personal or business account.

namestring required

The name to match the account name against.

Example request

{
  "paymentAccountId": "A123AAA4",
  "sortCode": "000000",
  "accountNumber": "12345678",
  "secondaryAccountId": "A-1234567890",
  "accountType": "PERSONAL",
  "name": "Joe Bloggs"
}

Response

Created

idstring required

Unique id for the account name check.

Example response

{
  "id": "C12001569Z",
  "result": {
    "code": "MATCHED",
    "name": "Joseph Bloggs"
  }
}