---
title: "Create a new customer"
method: POST
path: "/customers"
tags: ["Customers"]
---

# Create a new customer

`POST /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

## Request body

- OnboardingCreateCustomerRequest — Details of customer to create
  - `externalReference` string — External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long
  - `name` string — AlphaNumeric characters plus [ _ ' @ , & £ $ € ¥ = # % ‘ ’ : ; \ / < > « » ! ‘ “ ” . ? - *{ } + % ( )]. Mandatory for all types except 'INDIVIDUAL and PCM_INDIVIDUAL'
  - `companyRegNumber` string — Company registration number. Mandatory for 'LLC' and 'PLC'
  - `registeredAddress` OnboardingAddressRequest
    - `addressLine1` string, required
    - `addressLine2` string
    - `postTown` string, required
    - `postCode` string
    - `country` string — Mandatory for international payments.
    - `countrySubDivision` string
  - `tradingAddress` OnboardingAddressRequest
    - `addressLine1` string, required
    - `addressLine2` string
    - `postTown` string, required
    - `postCode` string
    - `country` string — Mandatory for international payments.
    - `countrySubDivision` string
  - `industryCode` string — 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` integer — Terms and conditions version. Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'
  - `type` string, required — 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. CHARITY -> charity 8. INDIVIDUAL -> individual consumer 9. PCM_INDIVIDUAL -> partner clearing model individual consumer 10. PCM_BUSINESS -> partner clearing model business consumer 11. TRUST -> trust customer 12. PREQUALIFIED -> only for use by customers who have been pre-authorised by Modulr
  - `expectedMonthlySpend` integer — Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'
  - `associates` OnboardingCreateAssociateRequest[] — Mandatory for all types except 'PCM_BUSINESS'
    - `type` string, required — Type of associate
    - `firstName` string, required — Letters, hyphens and apostrophes
    - `middleName` string — Letters, hyphens and apostrophes
    - `lastName` string, required — Letters, hyphens and apostrophes
    - `dateOfBirth` string — Date in yyyy-MM-dd format. If associate is a non-applicant director or partner, then partial DOB of yyyy-MM format is allowed. Valid age is from 16 to 150 years. If Applicant then minimum age required is 18 years for specific partners. Required for all associate types except PCM_INDIVIDUAL.
    - `ownership` integer — Ownership percentage for Partners
    - `homeAddress` OnboardingAddressRequest, required
      - `addressLine1` string, required
      - `addressLine2` string
      - `postTown` string, required
      - `postCode` string
      - `country` string — Mandatory for international payments.
      - `countrySubDivision` string
    - `applicant` boolean — Indicates if the associate is the applicant. Only one associate can be marked as such.
    - `email` string — Contact email address for applicants
    - `phone` string — Contact phone number for applicants, will be formatted into international number pattern
    - `documentInfo` OnboardingDocumentInfo[] — Information on uploaded documents
      - `path` string, required
      - `fileName` string, required
      - `uploadedDate` string, required — Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
    - `additionalIdentifiers` OnboardingAdditionalAssociateIdentifier[] — Additional identifiers
      - `type` 'BSN', required — Type of additional personal identifier
      - `value` string, required — Personal identifier value
    - `complianceData` OnboardingAssociateComplianceDataRequest
      - `relationship` string, required
    - `complianceId` string — Application Associate Compliance ID
    - `taxIdentifiers` OnboardingTaxIdentifier[] — Tax identifiers for the associate
      - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Country code (ISO Alpha-2) where the tax identifier was issued
      - `type` 'NIF' | 'CIF' | 'TIN' | 'BSN' — Tax identifier type
      - `value` string — Tax identifier value
    - `taxResidencies` string[] — Tax residencies for the associate
    - `documentDetails` OnboardingDocumentDetail[] — Document details for the associate
      - `countryOfIssue` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The issuing country code (ISO Alpha-2)
      - `type` 'PASSPORT' | 'DRIVING_LICENCE' | 'NATIONAL_IDENTITY_CARD' | 'VOTER_ID' | 'WORK_PERMIT' | 'OTHER_PROOF_OF_IDENTITY' — Type of document
      - `value` string, required — The document number
    - `departmentCode` string — Department code for the associate
    - `placeOfBirth` OnboardingPlaceOfBirth
      - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'
      - `city` string
    - `sex` 'MALE' | 'FEMALE' — Biological sex
    - `nationalities` string[]
  - `documentInfo` OnboardingDocumentInfo[] — information on uploaded documents
    - `path` string, required
    - `fileName` string, required
    - `uploadedDate` string, required — Valid date. 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
  - `provisionalCustomerId` string — Reference to provisional customer in onboarding flow
  - `customerTrust` OnboardingCustomerTrustRequest
    - `trustNature` 'BARE_TRUSTS' | 'INTEREST_IN_POSSESSION_TRUSTS' | 'DISCRETIONARY_TRUSTS' | 'ACCUMULATION_TRUSTS' | 'MIXED_TRUSTS' | 'SETTLOR_INTERESTED_TRUSTS' | 'NON_RESIDENT_TRUSTS' | 'OFFSHORE_TRUSTS' | 'FAMILY_LIVING_TRUST' | 'PILOT_TRUST' | 'VULNERABLE_BENEFICIARY_TRUST' | 'CHARITABLE_TRUSTS' | 'IRREVOCABLE_LIFE_INSURANCE_TRUST' | 'TESTAMENTARY_TRUSTS' | 'OTHER', required — Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers.
  - `taxProfile` OnboardingCustomerTaxProfileRequest
    - `taxIdentifier` string, required — Tax identifier for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers.
  - `complianceData` OnboardingCustomerComplianceDataRequest
    - `typeDescription` string — Required for customers of type PREQUALIFIED. Not allowed for all other customer types.
    - `riskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'UNDETERMINED' — Risk level of the customer
    - `vulnerabilityReasons` string[] — Vulnerability Reasons of the customer
    - `business` OnboardingBusinessDataRequest
      - `natureOfRelationship` string
      - `expectedTransactionalActivity` OnboardingExpectedTransactionalActivityRequest
        - `sourceOfFunds` string
        - `monthlyVolume` integer
        - `outboundPaymentJurisdictions` string[]
      - `screeningResults` OnboardingScreeningResultsRequest
        - `adverseMedia` string[]
        - `peps` string[]
        - `sanctions` string[]
      - `sourceOfWealth` OnboardingSourceOfWealthRequest
        - `standard` string
        - `pep` string
    - `consumer` OnboardingConsumerDataRequest
      - `employment` string
      - `natureOfRelationship` string
      - `expectedTransactionalActivity` OnboardingExpectedTransactionalActivityRequest
        - `sourceOfFunds` string
        - `monthlyVolume` integer
        - `outboundPaymentJurisdictions` string[]
      - `screeningResults` OnboardingScreeningResultsRequest
        - `adverseMedia` string[]
        - `peps` string[]
        - `sanctions` string[]
      - `sourceOfWealth` OnboardingSourceOfWealthRequest
        - `standard` string
        - `pep` string
  - `consumerDuty` OnboardingConsumerDuty
    - `scope` 'IN_SCOPE' | 'NOT_IN_SCOPE'
    - `numberOfEmployees` integer
    - `netAssets` number
    - `turnover` number
  - `knowYourBusiness` OnboardingKnowYourBusiness
    - `tradingName` string — The trading name of the business
    - `incorporationDate` string, date — Incorporation Date of the business
    - `businessActivities` string — The business activities of the business
    - `onlinePresenceUrl` string — The online presence URL of the business
    - `expectedMonthlyTransactions` integer — Expected Monthly Transactions of the business
  - `accountancy` OnboardingAccountancy
    - `directEmployeesOnly` boolean, required
    - `companyFormationServices` boolean, required
    - `amlBodySupervision` boolean, required
    - `amlPolicy` OnboardingDocumentInfo
      - `path` string, required
      - `fileName` string, required
      - `uploadedDate` string, required — Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
    - `amlOfficer` string, required
  - `travel` OnboardingTravel
    - `travelBodyDoc` OnboardingDocumentInfo
      - `path` string, required
      - `fileName` string, required
      - `uploadedDate` string, required — Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
  - `employmentServices` OnboardingEmploymentServices
    - `temporaryStaff` boolean, required
    - `directEmployeesOnly` boolean, required
  - `charity` OnboardingCharity
    - `onCharitiesCommission` boolean, required
    - `charityNumber` string
  - `legal` OnboardingLegal
    - `lawSocietyNumber` string, required
  - `taxIdentifiers` OnboardingTaxIdentifier[] — Tax Identifiers for the customer
    - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Country code (ISO Alpha-2) where the tax identifier was issued
    - `type` 'NIF' | 'CIF' | 'TIN' | 'BSN' — Tax identifier type
    - `value` string — Tax identifier value
  - `customerIdentificationInfo` OnboardingCustomerIdentificationInformation[] — Identification information for the customer
    - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The issuing country code in ISO Alpha-2 format
    - `type` 'INSEE' — Identifier type
    - `value` string — The identification value
  - `construction` OnboardingConstruction
    - `turnoverCashPercentage` integer, required
  - `contractCounterparty` 'MFBV' | 'MFSL' | 'MUS' — Business unit the customer contracts with

## Response `201`

Created

- OnboardingCustomer — A Customer is a single legal entity that can have 1 or more accounts
  - `id` string, required — Unique identifier for a Customer. Begins with 'C'
  - `name` string, required — Customer's company name - must be unique across the Modulr platform.
  - `brandNames` OnboardingBrandNameResponse[] — The customers brand name(s)
    - `id` string, required — Unique id for the Brand Name
    - `name` string, required — The Brand Name
  - `type` string, required — 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. CHARITY -> charity 8. INDIVIDUAL -> individual consumer 9. PCM_INDIVIDUAL -> partner clearing model individual consumer 10. PCM_BUSINESS -> partner clearing model business consumer
  - `status` 'ACTIVE' | 'CLOSED' | 'BLOCKED', required — Status of the Customer. Customers must be 'Active' for Accounts to be created for them.
  - `verificationStatus` string, required — 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
  - `companyRegNumber` string — The company registration / incorporation number of the company. Only applicable for companies registered with Companies House
  - `expectedMonthlySpend` integer — Indication of the monthly spend of the customer.
  - `registeredAddress` OnboardingAddressResponse — Address
    - `addressLine1` string, required
    - `addressLine2` string
    - `postTown` string, required
    - `postCode` string, required
    - `country` string, required
    - `countrySubDivision` string
  - `tradingAddress` OnboardingAddressResponse — Address
    - `addressLine1` string, required
    - `addressLine2` string
    - `postTown` string, required
    - `postCode` string, required
    - `country` string, required
    - `countrySubDivision` string
  - `partnerId` string — The owning partner identifier
  - `associates` OnboardingAssociateResponse[] — Array of associate objects that link to the Customer. For example, this could contain the details of the company directors for a Limited company, or or the partners for a partnership.
    - `id` string, required — Unique id for the Associate
    - `firstName` string, required — Associate's first name(s)
    - `middleName` string — Associate's middle name
    - `lastName` string, required — Associate's surname
    - `email` string — Associate's email address
    - `phone` string — Associate's phone number, in international number format
    - `applicant` boolean — Indicates which Associate originally applied for the Modulr account
    - `ownership` integer — The Associate's percentage ownership of the Customer
    - `type` string, required — Describes the relation between the Associate and the Customer. Can be one of
    - `dateOfBirth` string, required — Associate's date of birth in format yyyy-MM-dd, or format yyyy-MM where day is unknown
    - `verificationStatus` string, required — How the Associate was verified. Can be one of
    - `homeAddress` OnboardingAddressResponse — Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `postTown` string, required
      - `postCode` string, required
      - `country` string, required
      - `countrySubDivision` string
    - `documentInfo` OnboardingDocumentInfo[] — Documents gathered during Customer Due Diligence checks on an Associate.
      - `path` string, required
      - `fileName` string, required
      - `uploadedDate` string, required — Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
    - `additionalPersonalIdentifiers` OnboardingAdditionalPersonalIdentifierResponse[] — Additional personal identifier(s)
      - `type` 'BSN', required — The type of Additional Personal Identifier
      - `value` string, required — Additional Personal Identifier value
    - `complianceData` OnboardingAssociateComplianceDataResponse
      - `relationship` string
  - `industryCode` string
  - `tcsVersion` integer — Version of the Modulr Account Terms and Conditions the Customer has agreed to.
  - `documentInfo` OnboardingDocumentInfo[] — Array of document objects that relate to the Customer being created. Examples of Documents could be proof of a Company Director's identity or address, Articles of Association or a Partnership Agreement.
    - `path` string, required
    - `fileName` string, required
    - `uploadedDate` string, required — Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
  - `externalReference` string
  - `createdDate` string, date-time, required — 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
  - `delegate` OnboardingDelegateResponse — Delegate
    - `id` string, required — Unique reference for the Delegate.
    - `name` string, required — Name for the Delegate
    - `address` OnboardingAddressResponse — Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `postTown` string, required
      - `postCode` string, required
      - `country` string, required
      - `countrySubDivision` string
    - `roleId` string, required — The id of the Role assigned to the delegate
    - `externalReference` string — External system reference for the Delegate
    - `partner` string — Partner Bid.
    - `status` string, required — Status of the Delegate.
    - `created` string, date-time, required — Datetime the Delegate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
    - `updated` string, date-time, required — Datetime the Delegate was last updated.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
  - `customerTrust` OnboardingCustomerTrustResponse
    - `trustNature` 'BARE_TRUSTS' | 'INTEREST_IN_POSSESSION_TRUSTS' | 'DISCRETIONARY_TRUSTS' | 'ACCUMULATION_TRUSTS' | 'MIXED_TRUSTS' | 'SETTLOR_INTERESTED_TRUSTS' | 'NON_RESIDENT_TRUSTS' | 'OFFSHORE_TRUSTS' | 'FAMILY_LIVING_TRUST' | 'PILOT_TRUST' | 'VULNERABLE_BENEFICIARY_TRUST' | 'CHARITABLE_TRUSTS' | 'IRREVOCABLE_LIFE_INSURANCE_TRUST' | 'TESTAMENTARY_TRUSTS' | 'OTHER'
  - `taxProfile` OnboardingCustomerTaxProfileResponse
    - `taxIdentifier` string, required — Tax identifier for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers.
  - `complianceData` OnboardingCustomerComplianceDataResponse
    - `typeDescription` string
    - `riskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'UNDETERMINED'
    - `vulnerabilityReasons` string[]
    - `business` OnboardingBusinessDataResponse
      - `natureOfRelationship` string
      - `expectedTransactionalActivity` OnboardingExpectedTransactionalActivityResponse
        - `sourceOfFunds` string
        - `monthlyVolume` integer
        - `outboundPaymentJurisdictions` string[]
      - `screeningResults` OnboardingScreeningResultsResponse
        - `adverseMedia` string[]
        - `peps` string[]
        - `sanctions` string[]
      - `sourceOfWealth` OnboardingSourceOfWealthResponse
        - `standard` string
        - `pep` string
    - `consumer` OnboardingConsumerDataResponse
      - `employment` string
      - `natureOfRelationship` string
      - `expectedTransactionalActivity` OnboardingExpectedTransactionalActivityResponse
        - `sourceOfFunds` string
        - `monthlyVolume` integer
        - `outboundPaymentJurisdictions` string[]
      - `screeningResults` OnboardingScreeningResultsResponse
        - `adverseMedia` string[]
        - `peps` string[]
        - `sanctions` string[]
      - `sourceOfWealth` OnboardingSourceOfWealthResponse
        - `standard` string
        - `pep` string
  - `complianceSector` string
  - `generateStatements` boolean — True if the customer is configured to generate statements
  - `taxIdentifiers` OnboardingTaxIdentifier[] — Tax Identifiers for the customer
    - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Country code (ISO Alpha-2) where the tax identifier was issued
    - `type` 'NIF' | 'CIF' | 'TIN' | 'BSN' — Tax identifier type
    - `value` string — Tax identifier value

## Other responses

- `400` — Validation errors

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)