Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Customers

Retrieve a specific customer using a unique customer reference

Retrieve a specific customer using a unique customer reference. This identifier can be found in the response obtained after creating a new customer, it starts by C, e.g: C0000000

get/customers/{customerId}

Path parameters

customerIdstring required

ID of customer to fetch

Query parameters

statusesstring[]

Customer statuses allowed when fetching the customer

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"
}