How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Modulr

Modulr Beneficiaries API

Operations on Beneficiaries

Documentation Provider Profile APIs.io OpenAPI GitHub

Modulr Beneficiaries API is one of 26 APIs that Modulr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Beneficiaries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api-sandbox.modulrfinance.com/api-sandbox-token.

4 operations 3 paths 15 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.modulrfinance.com
Authentication
API Key, API Key
License
© Modulr Finance
Resource Areas
1

Authentication & Security 2

Modulr Beneficiaries API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (modulo_security). An API key is passed in the header as Authorization (TOKEN). By default, every request must be authenticated.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Beneficiaries 4

Operations on Beneficiaries

POST
/customers/{customerId}/beneficiaries
Create a new beneficiary for a specified customer
createBeneficiary 1 param body → 201400
DELETE
/customers/{customerId}/beneficiaries
Delete beneficiaries for a specified customer
deleteBeneficiaries 2 params → 200207400
GET
/beneficiaries
Retrieve beneficiaries
getBeneficiaries 34 params → 200400
GET
/beneficiaries/{beneficiaryId}/locks
Retrieve locked beneficiary entities
getLocks 3 params → 200400

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are account.BeneficiaryResponse (21 properties), account.IdentifierCountrySpecificDetailsResponse (12 properties), account.IdentifierCountrySpecificDetailsRequest (12 properties), account.CreateBeneficiaryRequest (10 properties). Each schema is shown below with its type and property counts.

account.id
array
ID of Customer(s) to fetch
account.state
array
Approval item state(s) to filter by
account.CreateBeneficiaryRequest
object
10 properties 3 required
account.IdentifierCountrySpecificDetailsResponse
object
12 properties
account.BeneficiaryLockPageResponse
object
5 properties
account.BeneficiaryLockResponse
object
BeneficiaryLock
2 properties
account.IdentifierCountrySpecificDetailsRequest
object
12 properties
account.IdentifierResponse
object
Account Identifier
9 properties
account.MessageResponse
object
5 properties
account.BeneficiaryPageResponse
object
5 properties
account.qualifier
array
A list of external qualifiers
account.IdentifierRequest
object
8 properties
account.BeneficiaryResponse
object
Beneficiary
21 properties
account.AddressResponse
object
Address
6 properties
account.AddressRequest
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-beneficiaries-api-openapi.yml Raw ↑

Other APIs Modulr publishes across the network.

Modulr Access Group API
AE Profile APIs.io
Modulr Accounts API
AE Profile APIs.io
Modulr Async API
AE Profile APIs.io
Modulr Card Simulator API
AE Profile APIs.io
Modulr Cards API
AE Profile APIs.io
Modulr Cards Bulk Operations API
AE Profile APIs.io
Modulr Channel Manager Card API
AE Profile APIs.io
Modulr Channel Manager Webhook Notifications API
AE Profile APIs.io
Modulr Confirmation of Payee API
AE Profile APIs.io
Modulr Customers API
AE Profile APIs.io
Modulr Direct Debit Outbound Mandate Operations API
AE Profile APIs.io
Modulr Direct Debits API
AE Profile APIs.io
#Beneficiaries
← Back to M APIs
API Details
ID
modulr:modulr-beneficiaries-api
Base URL
https://api.modulrfinance.com
Docs
https://modulr.readme.io/docs/account
Provider
Modulr
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=modulr-beneficiaries-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/modulr-beneficiaries-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Modulr Beneficiaries API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.