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 Customers API

Operations on Customers

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 27 operations across 22 paths, and defines 117 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.

27 operations 22 paths 117 schemas 5 GET1 PATCH10 POST11 PUT

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 Customers 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 27

Across 22 paths, the API surfaces 27 operations — 5 GET, 1 PATCH, 10 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 27

Operations on Customers

GET
/customers/{customerId}
Retrieve a specific customer using a unique customer reference
getCustomer 2 params → 200400
PUT
/customers/{customerId}
Edit a specific customer using a unique customer reference
editCustomer 1 param body → 200400
PATCH
/customers/{customerId}
Edit a customer
patchCustomer 1 param body → 200400
GET
/customers
Retrieve customers using filters
getCustomers 30 params → 200400
POST
/customers
Create a new customer
createCustomer body → 201400
POST
/keys/applications/{applicationId}
Create a secure Customer Verification SDK Session
createSdkKey 1 param → 201400403
POST
/applications
Create a New Onboarding Application
createApplication body → 201400403
POST
/applications/{applicationId}/verify
Submit an application for verification
verifyApplication 1 param → 200400403
POST
/applications/{applicationId}/submissions
Submit a business application for verification
submitApplication 1 param → 200400403
POST
/applications/{applicationId}/finalisations
Mark application as closed for modification
finaliseApplication 1 param → 200400403404
POST
/applications/{applicationId}/associates/{associateId}/submissions
Submit an associate for verification
submitAssociateForVerification 2 params → 200400403
PUT
/customers/{customerId}/compliance/tax-identifiers
Create or update a customer’s tax identifiers
updateTaxIdentifiersByCustomerId 1 param body → 204400403
PUT
/customers/{customerId}/compliance/identification-info
Create or update customer identification information
updateCustomerIdentificationInfosByCustomerId 1 param body → 204400403
PUT
/customers/{customerId}/compliance/associates/{associateId}/tax-residencies
Create or update the list of countries where an associate is considered tax-resident
updateTaxResidenciesForAssociate 2 params body → 204400403
PUT
/customers/{customerId}/compliance/associates/{associateId}/tax-identifiers
Create or update tax identifiers for an associate
updateTaxIdentifiersForAssociate 2 params body → 204400403
PUT
/customers/{customerId}/compliance/associates/{associateId}/personal-info
Create or update an associate’s personal details
updatePersonalInformationForAssociate 2 params body → 200400403
PUT
/customers/{customerId}/compliance/associates/{associateId}/fr/department
Create or update the department code for an associate
updateDepartmentForAssociate 2 params body → 204400403
PUT
/customers/{customerId}/compliance/associates/{associateId}/document-details
Create or update identification document details for an associate
updateIdentificationDocumentsDetailsForAssociate 2 params body → 204400403
PUT
/applications/{applicationId}/compliance/know-your-customer
Create or Update Know Your Customer Data for a Customer Application
updateKnowYourCustomerByApplicationId 1 param body → 200400403
PUT
/applications/{applicationId}/compliance/associates/{associateId}/tax-residencies
Create or Update Tax Residency Information for an Application Associate
updateTaxResidenciesForAssociate_1 2 params body → 204400403
PUT
/applications/{applicationId}/compliance/associates/{associateId}/personal-info
Create or Update Personal Details for an Application Associate
updatePersonalInformationForAssociate_1 2 params body → 200400403
GET
/applications/{applicationId}/compliance/businesses
Get business entity for an Onboarding Application
getBusiness 1 param → 200400403
POST
/applications/{applicationId}/compliance/businesses
Add a business entity to an Onboarding Application
createBusiness 1 param body → 201400403
GET
/applications/{applicationId}/compliance/businesses/addresses
Get business addresses for an Onboarding Application
getBusinessAddresses 3 params → 200400403404
POST
/applications/{applicationId}/compliance/businesses/addresses
Add a business address to an Onboarding Application
createBusinessAddress 1 param body → 201400403404409
POST
/applications/{applicationId}/compliance/associates
Add an individual/associated entity to an Onboarding Application
createApplicationAssociate 1 param body → 201400403404
GET
/customers/{customerId}/associates
Get all associates for a customer
getAssociatesByCustomer 2 params → 200400403

Schemas 117

The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are onboarding.CreateCustomerRequest (27 properties), onboarding.Customer (25 properties), account.Customer (24 properties), onboarding.CreateAssociateRequest (21 properties). Each schema is shown below with its type and property counts.

customercompliance.CreateBusinessResponse
object
1 property
account.CustomerTrustRequest
object
1 property 1 required
customercompliance.TaxResidenciesRequest
object
1 property
account.MessageResponse
object
5 properties
account.AdditionalPersonalIdentifierResponse
object
AdditionalPersonalIdentifier
2 properties
account.CustomerTrustResponse
object
1 property
onboarding.AdditionalAssociateIdentifier
object
2 properties 2 required
account.StringSearchCriteria
object
A list of external references to filter
2 properties 2 required
account.addressLines
array
Set of the address lines. If specified, they must be present in the address line 1 or in the address line 2. Search results by number may include numbers with…
customercompliance.MessageResponse
object
5 properties
customercompliance.AssociateSearchCriteria
object
3 properties
onboarding.SourceOfWealthRequest
object
2 properties
customercompliance.AssociateAdditionalIdentifier
object
Additional personal identifier
2 properties 2 required
onboarding.ExpectedTransactionalActivityRequest
object
3 properties
customercompliance.KnowYourCustomer
object
7 properties
account.SourceOfWealthRequest
object
2 properties
account.AssociateComplianceDataResponse
object
1 property
onboarding.CustomerTrustResponse
object
1 property
account.ConsumerDataRequest
object
5 properties
onboarding.Construction
object
1 property 1 required
customercompliance.AssociatePageResponse
object
5 properties
customercompliance.BusinessAddressesPageResponse
object
5 properties
account.Add
Add field
3 required
account.Customer
object
A Customer is a single legal entity that can have 1 or more accounts
24 properties
onboarding.TaxIdentifier
object
3 properties
onboarding.CustomerTaxProfileResponse
object
1 property 1 required
customercompliance.ContactDetailsRequest
object
2 properties 2 required
onboarding.ExpectedTransactionalActivityResponse
object
3 properties
customercompliance.TaxIdentifier
object
3 properties
account.BrandNameResponse
object
BrandName
2 properties
onboarding.DocumentDetail
object
3 properties 1 required
onboarding.ScreeningResultsResponse
object
3 properties
onboarding.CustomerTaxProfileRequest
object
1 property 1 required
account.UpdateBrandNameRequest
object
2 properties
customercompliance.PersonalInformation
object
4 properties
onboarding.DocumentInfo
object
3 properties 3 required
account.DelegateResponse
object
Delegate
9 properties
account.CustomerComplianceDataRequest
object
5 properties
onboarding.CustomerIdentificationInformation
object
3 properties
onboarding.ConsumerDataRequest
object
5 properties
account.Move
Move field
3 required
onboarding.ConsumerDuty
object
4 properties
account.BusinessDataRequest
object
4 properties
onboarding.BusinessDataResponse
object
4 properties
account.CustomerComplianceDataResponse
object
5 properties
onboarding.AssociateResponse
object
Associate
15 properties 6 required
account.ScreeningResultsResponse
object
3 properties
onboarding.AssociateComplianceDataResponse
object
1 property
account.delegateId
array
List of delegate IDs to retrieve linked customers
account.ScreeningResultsRequest
object
3 properties
account.DocumentInfo
object
Document
3 properties 3 required
onboarding.ConsumerDataResponse
object
5 properties
customercompliance.AddressRequest
object
5 properties 4 required
onboarding.CreateApplicationRequest
object
1 property 1 required
onboarding.Charity
object
2 properties 1 required
onboarding.KnowYourBusiness
object
5 properties
customercompliance.AssociateResponse
object
1 property
onboarding.AddressResponse
object
Address
6 properties 4 required
onboarding.Legal
object
1 property 1 required
account.SourceOfWealthResponse
object
2 properties
onboarding.DelegateResponse
object
Delegate
9 properties 6 required
customercompliance.CreateAssociateRequest
object
8 properties 6 required
account.BusinessDataResponse
object
4 properties
account.CustomerPageResponse
object
5 properties
customercompliance.BusinessResponse
object
4 properties
onboarding.SubmitAssociateResponse
object
1 property
customercompliance.DocumentDetail
object
3 properties 1 required
onboarding.CustomerComplianceDataResponse
object
5 properties
account.PatchOperation
object
2 properties 2 required
onboarding.CreateApplicationResponse
object
1 property
account.associateTypes
array
List of types to filter, can be one of: 1. DIRECTOR - director 2. PARTNER - partner 3. CSECRETARY - company secretary 4. SOLETRADER - sole trader 5. BENEOWNER…
account.ExpectedTransactionalActivityResponse
object
3 properties
customercompliance.TaxIdentifiersRequest
object
1 property
onboarding.CreateAssociateRequest
object
21 properties 4 required
onboarding.AddressRequest
object
6 properties 2 required
onboarding.EmploymentServices
object
2 properties 2 required
onboarding.Travel
object
1 property
onboarding.MessageResponse
object
5 properties
customercompliance.DocumentDetailsRequest
object
1 property
account.UpdateAssociateRequest
object
10 properties 3 required
onboarding.CustomerComplianceDataRequest
object
5 properties
onboarding.CreateCustomerRequest
object
Details of customer to create
27 properties 1 required
account.externalReference
array
A list of external references to filter
account.CustomerTaxProfileResponse
object
1 property
account.id
array
ID of Customer(s) to fetch
account.externalRef
array
A list of external references to filter
onboarding.Customer
object
A Customer is a single legal entity that can have 1 or more accounts
25 properties 6 required
account.Test
Test field
3 required
customercompliance.CustomerIdentificationInformationRequest
object
1 property
onboarding.ScreeningResultsRequest
object
3 properties
account.UpdateCustomerRequest
object
Details of customer to edit
7 properties
customercompliance.CustomerIdentificationInformation
object
3 properties
customercompliance.CreateBusinessAddressResponse
object
1 property
onboarding.CustomerTrustRequest
object
1 property 1 required
onboarding.BrandNameResponse
object
BrandName
2 properties 2 required
account.AssociateResponse
object
Associate
15 properties
customercompliance.BusinessAddressRequest
object
2 properties 2 required
account.Replace
Replace field
3 required
customercompliance.BusinessAddressResponse
object
3 properties
account.ConsumerDataResponse
object
5 properties
onboarding.AdditionalPersonalIdentifierResponse
object
AdditionalPersonalIdentifier
2 properties 2 required
customercompliance.Department
object
1 property
account.Remove
Remove field
2 required
onboarding.ApplicationSdkKeyResponse
object
3 properties
onboarding.PlaceOfBirth
object
2 properties
account.AddressRequest
object
6 properties
onboarding.FinaliseApplicationResponse
object
1 property
account.ExpectedTransactionalActivityRequest
object
3 properties
account.Copy
Copy field
3 required
onboarding.SourceOfWealthResponse
object
2 properties
onboarding.SubmitApplicationResponse
object
1 property
onboarding.AssociateComplianceDataRequest
object
1 property 1 required
onboarding.BusinessDataRequest
object
4 properties
account.JsonNode
onboarding.Accountancy
object
5 properties 4 required
account.AddressResponse
object
Address
6 properties
customercompliance.BusinessRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-customers-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 Beneficiaries 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 Direct Debit Outbound Mandate Operations API
AE Profile APIs.io
Modulr Direct Debits API
AE Profile APIs.io
#Customers
← Back to M APIs
API Details
ID
modulr:modulr-customers-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-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/modulr-customers-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 Customers 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.