Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Customers

Retrieve customers using filters

Either using unique references, such as customer ID, or filter parameters, such as verification status, get details of any customers found.

get/customers

Query parameters

idstring[]

ID of Customer(s) to fetch

ID of Customer(s) to fetch

delegateIdstring[]

List of delegate IDs to retrieve linked customers

qstring

Query parameter. ID, name or external reference of customer to search for

Query parameter. ID, name or external reference of customer to search for

type'LLC' | 'PLC' | 'SOLETRADER' | 'OPARTNRSHP' | 'LPARTNRSHP' | 'LLP' | 'INDIVIDUAL' | 'PCM_INDIVIDUAL' | 'PCM_BUSINESS' | 'TRUST' | 'PREQUALIFIED'

Type to filter, 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

Type to filter, 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
verificationStatus'UNVERIFIED' | 'VERIFIED' | 'EXVERIFIED' | 'REFERRED' | 'DECLINED' | 'REVIEWED'

Verification Status to filter, can be one of:

  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

Verification Status to filter, can be one of:

  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
fromCreatedDatestring

Customers created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Customers created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

toCreatedDatestring

Customers created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Customers created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

pageinteger

Page to fetch (0 indexed)

Page to fetch (0 indexed)

sizeinteger

Size of Page to fetch

Size of Page to fetch

sortFieldstring

Sort by field. Sorted by createdDate if not present

Sort by field. Sorted by createdDate if not present

sortOrderstring

Sorting order:

  1. asc -> ascendant
  2. desc -> descendant

Sorting order:

  1. asc -> ascendant
  2. desc -> descendant
externalRefstring[]

A list of external references to filter

A list of external references to filter

type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT' required

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

valuestring required

A list of external references to filter

name.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

name.valuestring
companyRegNumberstring

Customer registration number

Customer registration number

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

Customer legal entity

Customer legal entity

contractCounterparty'MFBV' | 'MFSL' | 'MUS'

Business unit the customer contracts with

The Modulr business unit with which the customer has contracted

addressLinesstring[]

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 any suffix

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 any suffix

postCodestring
postTownstring
countrystring
associateSearchCriteria.firstNameInitialstring

Person's first name initial

Person's first name initial

associateSearchCriteria.lastName.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

associateSearchCriteria.lastName.valuestring
associateSearchCriteria.lastNamePrefixstring

Person's prefix

Person's prefix

associateSearchCriteria.dateOfBirthstring date

Person's date of birth

Person's date of birth

associateSearchCriteria.additionalIdentifier.type'BSN'

Type of additional personal identifier

Type of additional personal identifier

associateSearchCriteria.additionalIdentifier.valuestring

Personal identifier value

Personal identifier value

associateTypesstring[]

List of types to filter, can be one of:

  1. DIRECTOR -> director
  2. PARTNER -> partner
  3. CSECRETARY -> company secretary
  4. SOLETRADER -> sole trader
  5. BENE_OWNER -> beneficial owner
  6. C_INTEREST -> controlling interest
  7. INDIVIDUAL -> individual
  8. PCM_INDIVIDUAL -> pcm individual
  9. SIGNATORY -> signatory
  10. TRUST_SETTLOR -> trust settlor
  11. TRUST_BENEFICIARY -> trust beneficiary
  12. TRUST_TRUSTEE -> trust trustee

List of types to filter, can be one of:

  1. DIRECTOR -> director
  2. PARTNER -> partner
  3. CSECRETARY -> company secretary
  4. SOLETRADER -> sole trader
  5. BENE_OWNER -> beneficial owner
  6. C_INTEREST -> controlling interest
  7. INDIVIDUAL -> individual
  8. PCM_INDIVIDUAL -> pcm individual
  9. SIGNATORY -> signatory
  10. TRUST_SETTLOR -> trust settlor
  11. TRUST_BENEFICIARY -> trust beneficiary
  12. TRUST_TRUSTEE -> trust trustee

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": [
    {
      "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"
    }
  ]
}