Create a new customer

post

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

This endpoint allows you to create a new customer. Creating a customer is a complex process with several dependencies, e.g: Directors, type of customer, legal specifications. For further information, please visit 'Creating a customer and account' entry on our API documentation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalReference

string

length between 0 and 50

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

name

string

length between 0 and 100

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

companyRegNumber

string

length between 0 and 40

Company registration number. Mandatory for 'LLC' and 'PLC'

registeredAddress

object

Mandatory for 'LLC', 'LLP' and 'LPARTNRSHP'

tradingAddress

object

Mandatory for all types except 'INDIVIDUAL' and 'PCM_INDIVIDUAL'

industryCode

string

length between 0 and 5

Mandatory for all types except 'INDIVIDUAL', 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'. In-house KYC partners -> Refer to Modulr Industry Code list. Outsourced KYC partners -> custom codes allowed.

tcsVersion

int32

1 to 1000

Terms and conditions version. Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'

type

string

required

length ≥ 1

Type of the customer, can be one of:

LLC -> limited company
PLC -> publicly listed company
SOLETRADER -> sole trader
OPARTNRSHP -> ordinary partnership
LPARTNRSHP -> limited partnership
LLP -> limited liability partnership
CHARITY -> charity
INDIVIDUAL -> individual consumer
PCM_INDIVIDUAL -> partner clearing model individual consumer
PCM_BUSINESS -> partner clearing model business consumer
TRUST -> trust customer
PREQUALIFIED -> only for use by customers who have been pre-authorised by Modulr

expectedMonthlySpend

int32

0 to 2147483647

Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'

associates

array of objects

Mandatory for all types except 'PCM_BUSINESS'

associates

documentInfo

array of objects

information on uploaded documents

documentInfo

legalEntity

string

enum

required

Legal entity of the customer

Allowed:

provisionalCustomerId

string

Reference to provisional customer in onboarding flow

customerTrust

object

Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers.

taxProfile

object

Tax profile for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers.

complianceData

object

Required for customers of type PREQUALIFIED.

consumerDuty

object

Consumer Duty data of the customer

knowYourBusiness

object

Know your business data of the customer

accountancy

object

Data provided for the accountancy industry

travel

object

Data provided for the travel industry

employmentServices

object

Data provided for the employment services industry

charity

object

Data provided for the charity industry

legal

object

Data provided for the legal industry

taxIdentifiers

array of objects

Tax Identifiers for the customer

taxIdentifiers

customerIdentificationInfo

array of objects

Identification information for the customer

customerIdentificationInfo

construction

object

Data provided for the construction industry

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Created

400Validation errors