Retrieve customers using filters

get

https://api-sandbox.modulrfinance.com/api-sandbox-token/customers

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

array of strings

ID of Customer(s) to fetch

delegateId

array of strings

List of delegate IDs to retrieve linked customers

delegateId

string

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

type

string

enum

Type to filter, can be one of:

LLC -> limited company
PLC -> publicly listed company
SOLETRADER -> sole trader
OPARTNRSHP -> ordinary partnership
LPARTNRSHP -> limited partnership
LLP -> limited liability partnership
INDIVIDUAL -> individual consumer
PCM_INDIVIDUAL -> partner clearing model individual consumer
PCM_BUSINESS -> partner clearing model business consumer

verificationStatus

string

enum

Verification Status to filter, can be one of:

UNVERIFIED -> no verification checks have been completed
VERIFIED -> verification checks completed satisfactorily
EXVERIFIED -> verification completed externally
REFERRED -> verification is pending manual review
DECLINED -> verification is complete with a negative result
REVIEWED -> verification check has been reviewed

Allowed:

fromCreatedDate

string

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

toCreatedDate

string

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

page

int32

≥ 0

Page to fetch (0 indexed)

size

int32

≤ 500

Size of Page to fetch

sortField

string

Sort by field. Sorted by createdDate if not present

sortOrder

string

Sorting order:

asc -> ascendant
desc -> descendant

externalRef

array of strings

deprecated

A list of external references to filter

externalRef

externalReference

array of objects

A list of external references to filter

externalReference

name.type

string

enum

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

Allowed:

name.value

string

length ≥ 1

companyRegNumber

string

Customer registration number

legalEntity

string

enum

Customer legal entity

Allowed:

addressLines

array of strings

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

addressLines

postCode

string

postTown

string

country

string

associateSearchCriteria.firstNameInitial

string

length between 1 and 1

Person's first name initial

associateSearchCriteria.lastName.type

string

enum

Allowed:

associateSearchCriteria.lastName.value

string

length ≥ 1

associateSearchCriteria.lastNamePrefix

string

Person's prefix

associateSearchCriteria.dateOfBirth

date

Person's date of birth

associateSearchCriteria.additionalIdentifier.type

string

enum

Type of additional personal identifier

Allowed:

associateSearchCriteria.additionalIdentifier.value

string

length ≥ 1

Personal identifier value

associateTypes

array of strings

List of types to filter, can be one of:

DIRECTOR -> director
PARTNER -> partner
CSECRETARY -> company secretary
SOLETRADER -> sole trader
BENE_OWNER -> beneficial owner
C_INTEREST -> controlling interest
INDIVIDUAL -> individual
PCM_INDIVIDUAL -> pcm individual
SIGNATORY -> signatory
TRUST_SETTLOR -> trust settlor
TRUST_BENEFICIARY -> trust beneficiary
TRUST_TRUSTEE -> trust trustee

associateTypes

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request