v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Beneficiaries

Retrieve locked beneficiary entities

Fetch references of the entities (payment, rule) that have caused the beneficiary to be locked

get/beneficiaries/{beneficiaryId}/locks

Path parameters

beneficiaryIdstring required

Query parameters

pageinteger

Page to fetch (0 indexed)

Page to fetch (0 indexed)

sizeinteger

Size of Page to fetch

Size of Page to fetch

Response

OK

sizeinteger

Page size

totalSizeinteger

Total count

pageinteger

Current page number, 0 based; i.e first-page = 0, second-page = 1

totalPagesinteger

Total pages

Example response

{
  "content": [
    {
      "ownerId": "R00000001A"
    }
  ]
}