Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Customers

Edit a specific customer using a unique customer reference

Currently editable fields:

<ol> <li>For all customer types: <b>externalReference</b> can be edited</li> <li>For all customers not requiring manual or in-house KYC verification: <b>industryCode</b>, <b>registeredAddress</b>, <b>tcsVersions</b> and <b>regNumber</b> can additionally be edited. Of those: <ul> <li>For all other customer types: <b>name</b> and <b>tradingAddress</b> can additionally be edited</li> <li>For all types other than PCM_BUSINESS: the <b>associate</b> can additionally be edited</li> </ul> </li> <li> For <b>vulnerabilityReason</b> you must supply a list and to delete a list you must supply an empty list in request, not supplying a list will result in no change</li> </ol>
put/customers/{customerId}

Path parameters

customerIdstring required

ID of customer to be edited

Request body

externalReferencestring

External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long

namestring

AlphaNumeric characters plus [ _ ' @ , & £ $ € ¥ = # % ‘ ’ : ; \ / < > « » ! ‘ “ ” . ? - *{ } + % ( )]. Mandatory for all types except 'INDIVIDUAL and PCM_INDIVIDUAL'

Response

OK

idstring

Unique identifier for a Customer. Begins with 'C'

namestring

Customer's company name - must be unique across the Modulr platform.

typestring

Type of the customer, can be one of:

  1. LLC -> limited company
  2. PLC -> publicly listed company
  3. SOLETRADER -> sole trader
  4. OPARTNRSHP -> ordinary partnership
  5. LPARTNRSHP -> limited partnership
  6. LLP -> limited liability partnership
  7. INDIVIDUAL -> individual consumer
  8. PCM_INDIVIDUAL -> partner clearing model individual consumer
  9. PCM_BUSINESS -> partner clearing model business consumer
status'ACTIVE' | 'CLOSED' | 'BLOCKED'

Status of the Customer. Customers must be 'Active' for Accounts to be created for them.

verificationStatusstring

How the identity of the Customer has been verified. Can be:

  1. UNVERIFIED -> no verification checks have been completed
  2. VERIFIED -> verification checks completed satisfactorily
  3. EXVERIFIED -> verification completed externally
  4. REFERRED -> verification is pending manual review
  5. DECLINED -> verification is complete with a negative result
  6. REVIEWED -> verification check has been reviewed
companyRegNumberstring

The company registration / incorporation number of the company. Only applicable for companies registered with Companies House

expectedMonthlySpendinteger

Indication of the monthly spend of the customer.

partnerIdstring

The owning partner identifier

industryCodestring
tcsVersioninteger

Version of the Modulr Account Terms and Conditions the Customer has agreed to.

externalReferencestring
createdDatestring date-time

Datetime when the customer was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

legalEntity'GB' | 'NL' | 'IE'

Legal entity of the customer

complianceSectorstring
generateStatementsboolean

True if the customer is configured to generate statements

Example response

{
  "id": "C00000001",
  "associates": [
    {
      "documentInfo": [
        {
          "uploadedDate": "2017-01-28T01:01:01+0000"
        }
      ]
    }
  ],
  "documentInfo": [
    {
      "uploadedDate": "2017-01-28T01:01:01+0000"
    }
  ],
  "createdDate": "2017-01-28T01:01:01+0000",
  "delegate": {
    "id": "D0000001",
    "roleId": "R02002M5",
    "partner": "R0000001",
    "created": "2017-01-28T01:01:01+0000",
    "updated": "2017-01-28T01:01:01+0000"
  },
  "complianceSector": "Agency Lite Consumer"
}