> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an account

> Starts the process of onboarding an account. This endpoint can only be accessed by product-level permissions.



## OpenAPI

````yaml /autogenerated/openapi/cis.openapi.json post /onboarding
openapi: 3.1.0
info:
  title: CIS API
  version: 2.0.0
  description: Version 2
  license:
    name: UNLICENSED
    url: https://docs.equalsmoney.com
servers:
  - url: https://api.equalsmoney.com/v2
    description: Production
  - url: https://api-sandbox.equalsmoney.com/v2
    description: Sandbox
security: []
paths:
  /onboarding:
    post:
      tags:
        - Onboarding
      summary: Create an account
      description: >-
        Starts the process of onboarding an account. This endpoint can only be
        accessed by product-level permissions.
      operationId: onboardAccount
      parameters:
        - name: productId
          in: query
          schema:
            description: The ID of the product to work with.
            type:
              - string
            format: uuid
            maxLength: 36
            example: 3ef24d53-6e22-4103-a16b-d268e4f7346d
            deprecated: true
      requestBody:
        description: Body
        content:
          application/json:
            schema:
              type:
                - object
              properties:
                accountType:
                  type:
                    - string
                  enum:
                    - business
                    - personal
                  description: The type of account that you want to onboard.
                affiliateId:
                  type:
                    - string
                  description: The affiliate ID.
                  example: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                companyId:
                  type:
                    - string
                  description: The company ID.
                  example: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                contact:
                  type:
                    - object
                  properties:
                    firstName:
                      type:
                        - string
                      description: The contact's first name.
                      example: John
                    lastName:
                      type:
                        - string
                      description: The contact's last name.
                      example: Doe
                    nationality:
                      type:
                        - string
                        - 'null'
                      enum:
                        - AD
                        - AE
                        - AF
                        - AG
                        - AI
                        - AL
                        - AM
                        - AO
                        - AQ
                        - AR
                        - AS
                        - AT
                        - AU
                        - AW
                        - AX
                        - AZ
                        - BA
                        - BB
                        - BD
                        - BE
                        - BF
                        - BG
                        - BH
                        - BI
                        - BJ
                        - BL
                        - BM
                        - BN
                        - BO
                        - BQ
                        - BR
                        - BS
                        - BT
                        - BV
                        - BW
                        - BY
                        - BZ
                        - CA
                        - CC
                        - CD
                        - CF
                        - CG
                        - CH
                        - CI
                        - CK
                        - CL
                        - CM
                        - CN
                        - CO
                        - CR
                        - CU
                        - CV
                        - CW
                        - CX
                        - CY
                        - CZ
                        - DE
                        - DJ
                        - DK
                        - DM
                        - DO
                        - DZ
                        - EC
                        - EE
                        - EG
                        - EH
                        - ER
                        - ES
                        - ET
                        - FI
                        - FJ
                        - FK
                        - FM
                        - FO
                        - FR
                        - GA
                        - GB
                        - GD
                        - GE
                        - GF
                        - GG
                        - GH
                        - GI
                        - GL
                        - GM
                        - GN
                        - GP
                        - GQ
                        - GR
                        - GS
                        - GT
                        - GU
                        - GW
                        - GY
                        - HK
                        - HM
                        - HN
                        - HR
                        - HT
                        - HU
                        - ID
                        - IE
                        - IL
                        - IM
                        - IN
                        - IO
                        - IQ
                        - IR
                        - IS
                        - IT
                        - JE
                        - JM
                        - JO
                        - JP
                        - KE
                        - KG
                        - KH
                        - KI
                        - KM
                        - KN
                        - KP
                        - KR
                        - KW
                        - KY
                        - KZ
                        - LA
                        - LB
                        - LC
                        - LI
                        - LK
                        - LR
                        - LS
                        - LT
                        - LU
                        - LV
                        - LY
                        - MA
                        - MC
                        - MD
                        - ME
                        - MF
                        - MG
                        - MH
                        - MK
                        - ML
                        - MM
                        - MN
                        - MO
                        - MP
                        - MQ
                        - MR
                        - MS
                        - MT
                        - MU
                        - MV
                        - MW
                        - MX
                        - MY
                        - MZ
                        - NA
                        - NC
                        - NE
                        - NF
                        - NG
                        - NI
                        - NL
                        - 'NO'
                        - NP
                        - NR
                        - NU
                        - NZ
                        - OM
                        - PA
                        - PE
                        - PF
                        - PG
                        - PH
                        - PK
                        - PL
                        - PM
                        - PN
                        - PR
                        - PS
                        - PT
                        - PW
                        - PY
                        - QA
                        - RE
                        - RO
                        - RS
                        - RU
                        - RW
                        - SA
                        - SB
                        - SC
                        - SD
                        - SE
                        - SG
                        - SH
                        - SI
                        - SJ
                        - SK
                        - SL
                        - SM
                        - SN
                        - SO
                        - SR
                        - SS
                        - ST
                        - SV
                        - SX
                        - SY
                        - SZ
                        - TC
                        - TD
                        - TF
                        - TG
                        - TH
                        - TJ
                        - TK
                        - TL
                        - TM
                        - TN
                        - TO
                        - TR
                        - TT
                        - TV
                        - TW
                        - TZ
                        - UA
                        - UG
                        - UM
                        - US
                        - UY
                        - UZ
                        - VA
                        - VC
                        - VE
                        - VG
                        - VI
                        - VN
                        - VU
                        - WF
                        - WS
                        - XK
                        - YE
                        - YT
                        - ZA
                        - ZM
                        - ZW
                      description: The contact's nationality country code.
                      example: GB
                    annualIncome:
                      type:
                        - object
                        - 'null'
                      properties:
                        currencyCode:
                          type:
                            - string
                          enum:
                            - AED
                            - AFN
                            - ALL
                            - AMD
                            - ANG
                            - AOA
                            - ARS
                            - AUD
                            - AWG
                            - AZN
                            - BAM
                            - BBD
                            - BDT
                            - BGN
                            - BHD
                            - BIF
                            - BMD
                            - BND
                            - BOB
                            - BOV
                            - BRL
                            - BSD
                            - BTN
                            - BWP
                            - BYN
                            - BZD
                            - CAD
                            - CDF
                            - CHF
                            - CLP
                            - CNY
                            - COP
                            - CRC
                            - CUC
                            - CUP
                            - CVE
                            - CZK
                            - DJF
                            - DKK
                            - DOP
                            - DZD
                            - EGP
                            - ERN
                            - ETB
                            - EUR
                            - FJD
                            - FKP
                            - GBP
                            - GEL
                            - GGP
                            - GHS
                            - GIP
                            - GMD
                            - GNF
                            - GTQ
                            - GYD
                            - HKD
                            - HNL
                            - HRK
                            - HTG
                            - HUF
                            - IDR
                            - ILS
                            - INR
                            - IQD
                            - IRR
                            - ISK
                            - JMD
                            - JOD
                            - JPY
                            - KES
                            - KGS
                            - KHR
                            - KMF
                            - KPW
                            - KRW
                            - KWD
                            - KYD
                            - KZT
                            - LAK
                            - LBP
                            - LKR
                            - LRD
                            - LSL
                            - LTL
                            - LVL
                            - LYD
                            - MAD
                            - MDL
                            - MGA
                            - MKD
                            - MMK
                            - MNT
                            - MOP
                            - MUR
                            - MVR
                            - MWK
                            - MXN
                            - MYR
                            - MZN
                            - NAD
                            - NGN
                            - NIO
                            - NOK
                            - NPR
                            - NZD
                            - OMR
                            - PAB
                            - PEN
                            - PGK
                            - PHP
                            - PKR
                            - PLN
                            - PYG
                            - QAR
                            - RON
                            - RSD
                            - RUB
                            - RWF
                            - SAR
                            - SBD
                            - SCR
                            - SEK
                            - SGD
                            - SHN
                            - SLL
                            - SOS
                            - SRD
                            - SSP
                            - STN
                            - SYP
                            - SZL
                            - THB
                            - TJS
                            - TMT
                            - TND
                            - TOP
                            - TRY
                            - TTD
                            - TWD
                            - TZS
                            - UAH
                            - UGX
                            - USD
                            - UYU
                            - UZS
                            - VND
                            - VUV
                            - WST
                            - XAF
                            - XAG
                            - XAU
                            - XCD
                            - XOF
                            - XPD
                            - XPF
                            - XPT
                            - YER
                            - ZAR
                            - ZMK
                            - ZMW
                            - ZWD
                          example: USD
                        value:
                          type:
                            - number
                      required:
                        - currencyCode
                        - value
                    email:
                      type:
                        - string
                      format: email
                      description: >-
                        The contact's email address. If this matches an existing
                        person, we'll create a new persona for them. If this
                        doesn't match an existing person, we'll create both a
                        new person and a new associated persona.
                      example: test@example.com
                    phone:
                      type:
                        - string
                      description: The contact's phone number.
                      example: '07123456789'
                    dob:
                      type:
                        - string
                        - 'null'
                      pattern: ^(0[1-9]|[12]\d|3[01])\/(0[1-9]|1[0-2])\/\d{4}$
                      description: >-
                        The contact's date of birth (`YYYY-MM-DD`). This is
                        required for `personal` accounts.
                      example: 19/01/1946
                    address:
                      type:
                        - object
                      properties:
                        addressLine1:
                          type:
                            - string
                          description: The first line of the account's address.
                          example: Great Building
                        addressLine2:
                          type:
                            - string
                            - 'null'
                          description: The second line of the account's address.
                          example: Greater Building
                        townCity:
                          type:
                            - string
                          description: The town or city of the account's address.
                          example: My Town
                        postCode:
                          type:
                            - string
                          description: The postal or ZIP code of the account's address.
                          example: SE13UB
                        countryCode:
                          type:
                            - string
                          description: The country code of the account's address.
                          example: GB
                      required:
                        - addressLine1
                        - townCity
                        - postCode
                        - countryCode
                  required:
                    - firstName
                    - lastName
                    - email
                    - phone
                    - address
                account:
                  oneOf:
                    - type:
                        - object
                      properties:
                        companyName:
                          type:
                            - string
                            - 'null'
                          description: The company's name.
                          example: My Company
                        companyNumber:
                          type:
                            - string
                            - 'null'
                          description: The company number.
                          example: '1111111111'
                        incorporationDate:
                          type:
                            - string
                            - 'null'
                          description: The company's date of incorporation.
                          example: '2004-01-30'
                        type:
                          type:
                            - string
                            - 'null'
                          enum:
                            - ltd
                            - private-limited-guarant-nsc-limited-exemption
                            - private-limited-guarant-nsc
                            - llp
                            - plc
                            - sole_trader
                            - charity
                            - charitable-incorporated-organisation
                            - partnership
                            - assurance-company
                            - converted-or-closed
                            - limited_by_guarantee
                            - limited-partnership
                            - oversea-company
                            - private-unlimited
                            - royal-charter
                            - registered-society-non-jurisdictional
                            - trust
                            - uk-establishment
                            - other
                          description: >-
                            The type of company that you're creating an account
                            for.
                          example: ltd
                        website:
                          type:
                            - string
                            - 'null'
                          description: The URL of the company's website.
                          example: https://www.my-business.com
                        onboardingDetail:
                          type:
                            - string
                            - 'null'
                          description: Optional additional details about the account.
                          example: detail
                        address:
                          type:
                            - object
                          properties:
                            addressLine1:
                              type:
                                - string
                              description: The first line of the account's address.
                              example: Great Building
                            addressLine2:
                              type:
                                - string
                                - 'null'
                              description: The second line of the account's address.
                              example: Greater Building
                            townCity:
                              type:
                                - string
                              description: The town or city of the account's address.
                              example: My Town
                            postCode:
                              type:
                                - string
                              description: The postal or ZIP code of the account's address.
                              example: SE13UB
                            countryCode:
                              type:
                                - string
                              description: The country code of the account's address.
                              example: GB
                          required:
                            - addressLine1
                            - townCity
                            - postCode
                            - countryCode
                      required:
                        - address
                    - type:
                        - object
                      properties:
                        companyName:
                          type:
                            - string
                          description: The company's name.
                          example: My Company
                        companyNumber:
                          type:
                            - string
                          description: The company number.
                          example: '1111111111'
                        incorporationDate:
                          type:
                            - string
                            - 'null'
                          description: The company's date of incorporation.
                          example: '2004-01-30'
                        type:
                          type:
                            - string
                          enum:
                            - ltd
                            - private-limited-guarant-nsc-limited-exemption
                            - private-limited-guarant-nsc
                            - llp
                            - plc
                            - sole_trader
                            - charity
                            - charitable-incorporated-organisation
                            - partnership
                            - assurance-company
                            - converted-or-closed
                            - limited_by_guarantee
                            - limited-partnership
                            - oversea-company
                            - private-unlimited
                            - royal-charter
                            - registered-society-non-jurisdictional
                            - trust
                            - uk-establishment
                            - other
                          description: >-
                            The type of company that you're creating an account
                            for.
                          example: ltd
                        website:
                          type:
                            - string
                            - 'null'
                          description: The URL of the company's website.
                          example: https://www.my-business.com
                        onboardingDetail:
                          type:
                            - string
                            - 'null'
                          description: Optional additional details about the account.
                          example: detail
                        address:
                          type:
                            - object
                          properties:
                            addressLine1:
                              type:
                                - string
                              description: The first line of the account's address.
                              example: Great Building
                            addressLine2:
                              type:
                                - string
                                - 'null'
                              description: The second line of the account's address.
                              example: Greater Building
                            townCity:
                              type:
                                - string
                              description: The town or city of the account's address.
                              example: My Town
                            postCode:
                              type:
                                - string
                              description: The postal or ZIP code of the account's address.
                              example: SE13UB
                            countryCode:
                              type:
                                - string
                              description: The country code of the account's address.
                              example: GB
                          required:
                            - addressLine1
                            - townCity
                            - postCode
                            - countryCode
                      required:
                        - companyName
                        - companyNumber
                        - type
                        - address
                kyc:
                  oneOf:
                    - type:
                        - object
                      properties:
                        mainPurpose:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - Business acquisition
                              - Business costs/revenue
                              - Charity
                              - Currency purchase/sale
                              - Dividend payments
                              - Inheritance
                              - Intercompany Transfers
                              - Investment
                              - Legal fees
                              - Loan
                              - Mortgage payments
                              - On-going payments to family
                              - One off payment
                              - Payment of services
                              - Payment to suppliers
                              - Property maintenance
                              - Property purchase
                              - Property sale
                              - Purchase of goods
                              - Relocating abroad
                              - Repatriation
                              - Royalties
                              - Sale of shares
                              - Study fees/tuition
                              - Vehicle purchase
                              - Incentives/Grants
                              - Tax payments
                              - Director's fees
                            description: The purpose of the payments.
                          example: Sale of shares
                        sourceOfFunds:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - salary
                              - savings
                              - property
                              - cryptocurrency
                              - inheritance
                              - other
                            description: The source of the funds.
                          example: salary
                        destinationOfFunds:
                          type:
                            - array
                          items:
                            type:
                              - string
                            description: >-
                              The destination of the funds, in ISO 3166-1 format
                              (alpha-2).
                          example: GB
                        currenciesRequired:
                          type:
                            - array
                          items:
                            type:
                              - string
                            description: The currencies required, in ISO 4217 format.
                          example: GBP
                        annualVolume:
                          type:
                            - string
                          description: The annual volume of payments.
                          example: Less than £10,000
                        numberOfPayments:
                          type:
                            - string
                          description: The number of payments.
                          example: More than 20 payments
                        expectedCardUse:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - advertising_and_marketing
                              - bills_and_utilities
                              - client_entertainment
                              - customer_incentives
                              - employee_incentives
                              - fuel_and_mileage_domestic
                              - fuel_and_mileage_overseas
                              - location_expenses__film__tv
                              - office_equipment
                              - online_subscriptions
                              - other
                              - payment_terminal_testing
                              - payroll
                              - per_diems
                              - petty_cash
                              - procurement__purchasing
                              - procurement__sourcing_
                              - travel_expenses_domestic
                              - travel_expenses_overseas
                            description: The expected use of the card.
                          example: advertising_and_marketing
                        averageLoad:
                          type:
                            - string
                          description: The expected average load.
                          example: '10000_25000'
                        numberOfCards:
                          type:
                            - string
                          description: The expected number of cards on the account.
                          example: '11_50'
                        cardFourthLine:
                          type:
                            - string
                          description: >-
                            The line that appears below the name on the payment
                            card. For example, `Equals Money`. This is only for
                            business accounts. Note that text that is longer
                            than 15 characters will be truncated.
                          example: CUSTOMER
                        employeeCards:
                          type:
                            - boolean
                          description: >-
                            Whether or not the employee cards feature is
                            enabled.
                          example: true
                        atmWithdrawals:
                          type:
                            - boolean
                          description: >-
                            Whether or not the card can be used for withdrawals
                            at automated teller machines (ATMs).
                          example: true
                      required:
                        - mainPurpose
                        - sourceOfFunds
                        - destinationOfFunds
                        - currenciesRequired
                        - annualVolume
                        - numberOfPayments
                        - expectedCardUse
                        - averageLoad
                        - numberOfCards
                        - cardFourthLine
                        - employeeCards
                        - atmWithdrawals
                      additionalProperties: true
                    - type:
                        - object
                      properties:
                        expectedCardUse:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - advertising_and_marketing
                              - bills_and_utilities
                              - client_entertainment
                              - customer_incentives
                              - employee_incentives
                              - fuel_and_mileage_domestic
                              - fuel_and_mileage_overseas
                              - location_expenses__film__tv
                              - office_equipment
                              - online_subscriptions
                              - other
                              - payment_terminal_testing
                              - payroll
                              - per_diems
                              - petty_cash
                              - procurement__purchasing
                              - procurement__sourcing_
                              - travel_expenses_domestic
                              - travel_expenses_overseas
                            description: The expected use of the card.
                          example: advertising_and_marketing
                        sourceOfFunds:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - salary
                              - savings
                              - property
                              - cryptocurrency
                              - inheritance
                              - other
                            description: The source of the funds.
                          example: salary
                        currenciesRequired:
                          type:
                            - array
                          items:
                            type:
                              - string
                            description: The currencies required, in ISO 4217 format.
                          example: GBP
                        averageLoad:
                          type:
                            - string
                          description: The expected average load.
                          example: '10000_25000'
                        numberOfCards:
                          type:
                            - string
                          description: The expected number of cards on the account.
                          example: '11_50'
                        cardFourthLine:
                          type:
                            - string
                          description: >-
                            The line that appears below the name on the payment
                            card. For example, `Equals Money`. This is only for
                            business accounts. Note that text that is longer
                            than 15 characters will be truncated.
                          example: CUSTOMER
                        employeeCards:
                          type:
                            - boolean
                          description: >-
                            Whether or not the employee cards feature is
                            enabled.
                          example: true
                        atmWithdrawals:
                          type:
                            - boolean
                          description: >-
                            Whether or not the card can be used for withdrawals
                            at automated teller machines (ATMs).
                          example: true
                      required:
                        - expectedCardUse
                        - sourceOfFunds
                        - currenciesRequired
                        - averageLoad
                        - numberOfCards
                        - cardFourthLine
                        - employeeCards
                        - atmWithdrawals
                      additionalProperties: true
                    - type:
                        - object
                      properties:
                        mainPurpose:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - Business acquisition
                              - Business costs/revenue
                              - Charity
                              - Currency purchase/sale
                              - Dividend payments
                              - Inheritance
                              - Intercompany Transfers
                              - Investment
                              - Legal fees
                              - Loan
                              - Mortgage payments
                              - On-going payments to family
                              - One off payment
                              - Payment of services
                              - Payment to suppliers
                              - Property maintenance
                              - Property purchase
                              - Property sale
                              - Purchase of goods
                              - Relocating abroad
                              - Repatriation
                              - Royalties
                              - Sale of shares
                              - Study fees/tuition
                              - Vehicle purchase
                              - Incentives/Grants
                              - Tax payments
                              - Director's fees
                            description: The purpose of the payments.
                          example: Sale of shares
                        sourceOfFunds:
                          type:
                            - array
                          items:
                            type:
                              - string
                            enum:
                              - salary
                              - savings
                              - property
                              - cryptocurrency
                              - inheritance
                              - other
                            description: The source of the funds.
                          example: salary
                        destinationOfFunds:
                          type:
                            - array
                          items:
                            type:
                              - string
                            description: >-
                              The destination of the funds, in ISO 3166-1 format
                              (alpha-2).
                          example: GB
                        currenciesRequired:
                          type:
                            - array
                          items:
                            type:
                              - string
                            description: The currencies required, in ISO 4217 format.
                          example: GBP
                        annualVolume:
                          type:
                            - string
                          description: The annual volume of payments.
                          example: Less than £10,000
                        numberOfPayments:
                          type:
                            - string
                          description: The number of payments.
                          example: More than 20 payments
                      required:
                        - mainPurpose
                        - sourceOfFunds
                        - destinationOfFunds
                        - currenciesRequired
                        - annualVolume
                        - numberOfPayments
                      additionalProperties: true
                market:
                  default: UK
                  type:
                    - string
                  enum:
                    - UK
                    - EU
                    - US
                    - UP
                  description: >-
                    The market relating to the license that the account operates
                    under. This may be different from the geographical region
                    that the account operates in. Currently, we support UK, US,
                    EU, and UP market accounts, but your account's geographical
                    region doesn't necessarily have to be the one of those. The
                    API validates that the selected market is allowed for the
                    product.
                  example: UK
                features:
                  type:
                    - array
                  items:
                    type:
                      - string
                    enum:
                      - payments
                      - cards
                    description: >-
                      The feature that you want to enable on the account. If not
                      provided, this defaults to `payments`.
                  example: payments
                preferredLanguage:
                  type:
                    - string
                  enum:
                    - EN
                    - FR
                    - DE
                    - ES
                    - IT
                    - NL
                    - PT
                  description: >-
                    The preferred language for business correspondence. ISO
                    639-1 uppercase.
              required:
                - accountType
                - contact
                - kyc
              example:
                accountType: business
                affiliateId: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                companyId: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                contact:
                  firstName: John
                  lastName: Doe
                  nationality: GB
                  annualIncome:
                    currencyCode: USD
                    value: 0
                  email: test@example.com
                  phone: '07123456789'
                  dob: 19/01/1946
                  address:
                    addressLine1: Great Building
                    addressLine2: Greater Building
                    townCity: My Town
                    postCode: SE13UB
                    countryCode: GB
                account:
                  companyName: My Company
                  companyNumber: '1111111111'
                  incorporationDate: '2004-01-30'
                  type: ltd
                  website: https://www.my-business.com
                  onboardingDetail: detail
                  address:
                    addressLine1: Great Building
                    addressLine2: Greater Building
                    townCity: My Town
                    postCode: SE13UB
                    countryCode: GB
                kyc:
                  mainPurpose: Sale of shares
                  sourceOfFunds: salary
                  destinationOfFunds: GB
                  currenciesRequired: GBP
                  annualVolume: Less than £10,000
                  numberOfPayments: More than 20 payments
                  expectedCardUse: advertising_and_marketing
                  averageLoad: '10000_25000'
                  numberOfCards: '11_50'
                  cardFourthLine: CUSTOMER
                  employeeCards: true
                  atmWithdrawals: true
                market: UK
                features: payments
                preferredLanguage: EN
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  ok:
                    type:
                      - boolean
                    description: Indicates if the onboarding was successful.
                  correlationId:
                    type:
                      - string
                    description: >-
                      The unique identifier used to track and link events in the
                      `AccountActivated` and `AccountCreated` webhooks.
                  account:
                    type:
                      - object
                    properties:
                      product:
                        type:
                          - string
                        description: The name of the product.
                        example: EQUALSMONEY
                      market:
                        type:
                          - string
                        enum:
                          - UK
                          - EU
                          - US
                          - UP
                        description: >-
                          The market relating to the license that the account
                          operates under. This may be different from the
                          geographical region that the account operates in.
                          Currently, we support UK, US, EU, and UP market
                          accounts, but your account's geographical region
                          doesn't necessarily have to be one of those.
                        example: UK
                      features:
                        type:
                          - array
                        items:
                          type:
                            - string
                          description: The account features.
                        example: payments
                      accountType:
                        type:
                          - string
                        description: The account type.
                        example: business
                      affiliateId:
                        type:
                          - string
                        format: uuid
                        description: The affiliate ID.
                        example: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                      companyId:
                        type:
                          - string
                        format: uuid
                        description: The company ID.
                        example: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                      preferredLanguage:
                        type:
                          - string
                          - 'null'
                        enum:
                          - EN
                          - FR
                          - DE
                          - ES
                          - IT
                          - NL
                          - PT
                        description: >-
                          The preferred language for business correspondence.
                          ISO 639-1 uppercase.
                      contact:
                        type:
                          - object
                        properties:
                          firstName:
                            type:
                              - string
                            description: The contact's first name.
                            example: John
                          lastName:
                            type:
                              - string
                            description: The contact's last name.
                            example: Doe
                          nationality:
                            type:
                              - string
                              - 'null'
                            enum:
                              - AD
                              - AE
                              - AF
                              - AG
                              - AI
                              - AL
                              - AM
                              - AO
                              - AQ
                              - AR
                              - AS
                              - AT
                              - AU
                              - AW
                              - AX
                              - AZ
                              - BA
                              - BB
                              - BD
                              - BE
                              - BF
                              - BG
                              - BH
                              - BI
                              - BJ
                              - BL
                              - BM
                              - BN
                              - BO
                              - BQ
                              - BR
                              - BS
                              - BT
                              - BV
                              - BW
                              - BY
                              - BZ
                              - CA
                              - CC
                              - CD
                              - CF
                              - CG
                              - CH
                              - CI
                              - CK
                              - CL
                              - CM
                              - CN
                              - CO
                              - CR
                              - CU
                              - CV
                              - CW
                              - CX
                              - CY
                              - CZ
                              - DE
                              - DJ
                              - DK
                              - DM
                              - DO
                              - DZ
                              - EC
                              - EE
                              - EG
                              - EH
                              - ER
                              - ES
                              - ET
                              - FI
                              - FJ
                              - FK
                              - FM
                              - FO
                              - FR
                              - GA
                              - GB
                              - GD
                              - GE
                              - GF
                              - GG
                              - GH
                              - GI
                              - GL
                              - GM
                              - GN
                              - GP
                              - GQ
                              - GR
                              - GS
                              - GT
                              - GU
                              - GW
                              - GY
                              - HK
                              - HM
                              - HN
                              - HR
                              - HT
                              - HU
                              - ID
                              - IE
                              - IL
                              - IM
                              - IN
                              - IO
                              - IQ
                              - IR
                              - IS
                              - IT
                              - JE
                              - JM
                              - JO
                              - JP
                              - KE
                              - KG
                              - KH
                              - KI
                              - KM
                              - KN
                              - KP
                              - KR
                              - KW
                              - KY
                              - KZ
                              - LA
                              - LB
                              - LC
                              - LI
                              - LK
                              - LR
                              - LS
                              - LT
                              - LU
                              - LV
                              - LY
                              - MA
                              - MC
                              - MD
                              - ME
                              - MF
                              - MG
                              - MH
                              - MK
                              - ML
                              - MM
                              - MN
                              - MO
                              - MP
                              - MQ
                              - MR
                              - MS
                              - MT
                              - MU
                              - MV
                              - MW
                              - MX
                              - MY
                              - MZ
                              - NA
                              - NC
                              - NE
                              - NF
                              - NG
                              - NI
                              - NL
                              - 'NO'
                              - NP
                              - NR
                              - NU
                              - NZ
                              - OM
                              - PA
                              - PE
                              - PF
                              - PG
                              - PH
                              - PK
                              - PL
                              - PM
                              - PN
                              - PR
                              - PS
                              - PT
                              - PW
                              - PY
                              - QA
                              - RE
                              - RO
                              - RS
                              - RU
                              - RW
                              - SA
                              - SB
                              - SC
                              - SD
                              - SE
                              - SG
                              - SH
                              - SI
                              - SJ
                              - SK
                              - SL
                              - SM
                              - SN
                              - SO
                              - SR
                              - SS
                              - ST
                              - SV
                              - SX
                              - SY
                              - SZ
                              - TC
                              - TD
                              - TF
                              - TG
                              - TH
                              - TJ
                              - TK
                              - TL
                              - TM
                              - TN
                              - TO
                              - TR
                              - TT
                              - TV
                              - TW
                              - TZ
                              - UA
                              - UG
                              - UM
                              - US
                              - UY
                              - UZ
                              - VA
                              - VC
                              - VE
                              - VG
                              - VI
                              - VN
                              - VU
                              - WF
                              - WS
                              - XK
                              - YE
                              - YT
                              - ZA
                              - ZM
                              - ZW
                            description: The contact's nationality country code.
                            example: GB
                          annualIncome:
                            type:
                              - object
                              - 'null'
                            properties:
                              currencyCode:
                                type:
                                  - string
                                enum:
                                  - AED
                                  - AFN
                                  - ALL
                                  - AMD
                                  - ANG
                                  - AOA
                                  - ARS
                                  - AUD
                                  - AWG
                                  - AZN
                                  - BAM
                                  - BBD
                                  - BDT
                                  - BGN
                                  - BHD
                                  - BIF
                                  - BMD
                                  - BND
                                  - BOB
                                  - BOV
                                  - BRL
                                  - BSD
                                  - BTN
                                  - BWP
                                  - BYN
                                  - BZD
                                  - CAD
                                  - CDF
                                  - CHF
                                  - CLP
                                  - CNY
                                  - COP
                                  - CRC
                                  - CUC
                                  - CUP
                                  - CVE
                                  - CZK
                                  - DJF
                                  - DKK
                                  - DOP
                                  - DZD
                                  - EGP
                                  - ERN
                                  - ETB
                                  - EUR
                                  - FJD
                                  - FKP
                                  - GBP
                                  - GEL
                                  - GGP
                                  - GHS
                                  - GIP
                                  - GMD
                                  - GNF
                                  - GTQ
                                  - GYD
                                  - HKD
                                  - HNL
                                  - HRK
                                  - HTG
                                  - HUF
                                  - IDR
                                  - ILS
                                  - INR
                                  - IQD
                                  - IRR
                                  - ISK
                                  - JMD
                                  - JOD
                                  - JPY
                                  - KES
                                  - KGS
                                  - KHR
                                  - KMF
                                  - KPW
                                  - KRW
                                  - KWD
                                  - KYD
                                  - KZT
                                  - LAK
                                  - LBP
                                  - LKR
                                  - LRD
                                  - LSL
                                  - LTL
                                  - LVL
                                  - LYD
                                  - MAD
                                  - MDL
                                  - MGA
                                  - MKD
                                  - MMK
                                  - MNT
                                  - MOP
                                  - MUR
                                  - MVR
                                  - MWK
                                  - MXN
                                  - MYR
                                  - MZN
                                  - NAD
                                  - NGN
                                  - NIO
                                  - NOK
                                  - NPR
                                  - NZD
                                  - OMR
                                  - PAB
                                  - PEN
                                  - PGK
                                  - PHP
                                  - PKR
                                  - PLN
                                  - PYG
                                  - QAR
                                  - RON
                                  - RSD
                                  - RUB
                                  - RWF
                                  - SAR
                                  - SBD
                                  - SCR
                                  - SEK
                                  - SGD
                                  - SHN
                                  - SLL
                                  - SOS
                                  - SRD
                                  - SSP
                                  - STN
                                  - SYP
                                  - SZL
                                  - THB
                                  - TJS
                                  - TMT
                                  - TND
                                  - TOP
                                  - TRY
                                  - TTD
                                  - TWD
                                  - TZS
                                  - UAH
                                  - UGX
                                  - USD
                                  - UYU
                                  - UZS
                                  - VND
                                  - VUV
                                  - WST
                                  - XAF
                                  - XAG
                                  - XAU
                                  - XCD
                                  - XOF
                                  - XPD
                                  - XPF
                                  - XPT
                                  - YER
                                  - ZAR
                                  - ZMK
                                  - ZMW
                                  - ZWD
                                example: USD
                              value:
                                type:
                                  - number
                            required:
                              - currencyCode
                              - value
                          email:
                            type:
                              - string
                            format: email
                            description: >-
                              The contact's email address. If this matches an
                              existing person, we'll create a new persona for
                              them. If this doesn't match an existing person,
                              we'll create both a new person and a new
                              associated persona.
                            example: test@example.com
                          phone:
                            type:
                              - string
                            description: The contact's phone number.
                            example: '07123456789'
                          dob:
                            type:
                              - string
                              - 'null'
                            pattern: ^(0[1-9]|[12]\d|3[01])\/(0[1-9]|1[0-2])\/\d{4}$
                            description: >-
                              The contact's date of birth (`YYYY-MM-DD`). This
                              is required for `personal` accounts.
                            example: 19/01/1946
                          address:
                            type:
                              - object
                            properties:
                              addressLine1:
                                type:
                                  - string
                                description: The first line of the account's address.
                                example: Great Building
                              addressLine2:
                                type:
                                  - string
                                  - 'null'
                                description: The second line of the account's address.
                                example: Greater Building
                              townCity:
                                type:
                                  - string
                                description: The town or city of the account's address.
                                example: My Town
                              postCode:
                                type:
                                  - string
                                description: >-
                                  The postal or ZIP code of the account's
                                  address.
                                example: SE13UB
                              countryCode:
                                type:
                                  - string
                                description: The country code of the account's address.
                                example: GB
                            required:
                              - addressLine1
                              - townCity
                              - postCode
                              - countryCode
                        required:
                          - firstName
                          - lastName
                          - email
                          - phone
                          - address
                      account:
                        type:
                          - object
                        properties:
                          companyName:
                            type:
                              - string
                            description: The company's name.
                            example: My Company
                          companyNumber:
                            type:
                              - string
                            description: The company number.
                            example: '1111111111'
                          incorporationDate:
                            type:
                              - string
                            description: The company's date of incorporation.
                            example: '1980-01-30'
                          type:
                            type:
                              - string
                            enum:
                              - ltd
                              - private-limited-guarant-nsc-limited-exemption
                              - private-limited-guarant-nsc
                              - llp
                              - plc
                              - sole_trader
                              - charity
                              - charitable-incorporated-organisation
                              - partnership
                              - assurance-company
                              - converted-or-closed
                              - limited_by_guarantee
                              - limited-partnership
                              - oversea-company
                              - private-unlimited
                              - royal-charter
                              - registered-society-non-jurisdictional
                              - trust
                              - uk-establishment
                              - other
                            description: >-
                              The type of company that you're creating an
                              account for.
                            example: ltd
                          website:
                            type:
                              - string
                            format: uri
                            description: The URL of the company's website.
                            example: https://www.my-business.com
                          onboardingDetail:
                            type:
                              - string
                            description: Optional additional details about the account.
                            example: detail
                          address:
                            type:
                              - object
                            properties:
                              addressLine1:
                                type:
                                  - string
                                description: The first line of the account's address.
                                example: Great Building
                              addressLine2:
                                type:
                                  - string
                                  - 'null'
                                description: The second line of the account's address.
                                example: Greater Building
                              townCity:
                                type:
                                  - string
                                description: The town or city of the account's address.
                                example: My Town
                              postCode:
                                type:
                                  - string
                                description: >-
                                  The postal or ZIP code of the account's
                                  address.
                                example: SE13UB
                              countryCode:
                                type:
                                  - string
                                description: The country code of the account's address.
                                example: GB
                            required:
                              - addressLine1
                              - townCity
                              - postCode
                              - countryCode
                        required:
                          - companyName
                          - companyNumber
                          - incorporationDate
                          - type
                          - onboardingDetail
                          - address
                      kyc:
                        type:
                          - object
                        properties:
                          expectedCardUse:
                            type:
                              - array
                            items:
                              type:
                                - string
                              enum:
                                - advertising_and_marketing
                                - bills_and_utilities
                                - client_entertainment
                                - customer_incentives
                                - employee_incentives
                                - fuel_and_mileage_domestic
                                - fuel_and_mileage_overseas
                                - location_expenses__film__tv
                                - office_equipment
                                - online_subscriptions
                                - other
                                - payment_terminal_testing
                                - payroll
                                - per_diems
                                - petty_cash
                                - procurement__purchasing
                                - procurement__sourcing_
                                - travel_expenses_domestic
                                - travel_expenses_overseas
                              description: The expected use of the card.
                            example: advertising_and_marketing
                          onboardingDetail:
                            type:
                              - string
                            description: Optional additional details about the account.
                            example: Extra info supplied by customer
                          sourceOfFunds:
                            type:
                              - array
                            items:
                              type:
                                - string
                              enum:
                                - salary
                                - savings
                                - property
                                - cryptocurrency
                                - inheritance
                                - other
                              description: The source of the funds.
                            example: salary
                          currenciesRequired:
                            type:
                              - array
                            items:
                              type:
                                - string
                              description: The currencies required, in ISO 4217 format.
                            example: GBP
                          averageLoad:
                            type:
                              - string
                            description: The expected average load.
                            example: '10000_25000'
                          numberOfCards:
                            type:
                              - string
                            description: The expected number of cards on the account.
                            example: '11_50'
                          numberOfPayments:
                            type:
                              - string
                            description: The expected number of payments.
                            example: More than 20 payments
                          destinationOfFunds:
                            type:
                              - array
                            items:
                              type:
                                - string
                              description: >-
                                The destination of the funds, in ISO 3166-1
                                format (alpha-2).
                            example: GB
                          mainPurpose:
                            type:
                              - array
                            items:
                              type:
                                - string
                              enum:
                                - Business acquisition
                                - Business costs/revenue
                                - Charity
                                - Currency purchase/sale
                                - Dividend payments
                                - Inheritance
                                - Intercompany Transfers
                                - Investment
                                - Legal fees
                                - Loan
                                - Mortgage payments
                                - On-going payments to family
                                - One off payment
                                - Payment of services
                                - Payment to suppliers
                                - Property maintenance
                                - Property purchase
                                - Property sale
                                - Purchase of goods
                                - Relocating abroad
                                - Repatriation
                                - Royalties
                                - Sale of shares
                                - Study fees/tuition
                                - Vehicle purchase
                                - Incentives/Grants
                                - Tax payments
                                - Director's fees
                              description: The purpose of the payments.
                            example: Sale of shares
                          cardFourthLine:
                            type:
                              - string
                            description: >-
                              The line that appears below the name on the
                              payment card. For example, `Equals Money`. This is
                              only for business accounts. Note that text that is
                              longer than 15 characters will be truncated.
                            example: CUSTOMER
                          employeeCards:
                            type:
                              - boolean
                            description: >-
                              Whether or not the employee cards feature is
                              enabled.
                            example: true
                          atmWithdrawals:
                            type:
                              - boolean
                            description: >-
                              Whether or not the card can be used for
                              withdrawals at automated teller machines (ATMs).
                            example: true
                          annualVolume:
                            type:
                              - string
                            description: The annual volume of payments.
                            example: Less than £10,000
                        required:
                          - expectedCardUse
                          - sourceOfFunds
                          - currenciesRequired
                          - averageLoad
                          - numberOfCards
                          - cardFourthLine
                          - employeeCards
                          - atmWithdrawals
                        description: Details about the account's KYC.
                    required:
                      - product
                      - market
                      - features
                      - accountType
                      - preferredLanguage
                      - contact
                      - account
                      - kyc
                    description: Details about the account.
                required:
                  - ok
                  - correlationId
                  - account
                example:
                  ok: true
                  correlationId: string
                  account:
                    product: EQUALSMONEY
                    market: UK
                    features: payments
                    accountType: business
                    affiliateId: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                    companyId: 420e4d3c-2d51-4cad-9caf-d7300258cefd
                    preferredLanguage: EN
                    contact:
                      firstName: John
                      lastName: Doe
                      nationality: GB
                      annualIncome:
                        currencyCode: USD
                        value: 0
                      email: test@example.com
                      phone: '07123456789'
                      dob: 19/01/1946
                      address:
                        addressLine1: Great Building
                        addressLine2: Greater Building
                        townCity: My Town
                        postCode: SE13UB
                        countryCode: GB
                    account:
                      companyName: My Company
                      companyNumber: '1111111111'
                      incorporationDate: '1980-01-30'
                      type: ltd
                      website: https://www.my-business.com
                      onboardingDetail: detail
                      address:
                        addressLine1: Great Building
                        addressLine2: Greater Building
                        townCity: My Town
                        postCode: SE13UB
                        countryCode: GB
                    kyc:
                      expectedCardUse: advertising_and_marketing
                      onboardingDetail: Extra info supplied by customer
                      sourceOfFunds: salary
                      currenciesRequired: GBP
                      averageLoad: '10000_25000'
                      numberOfCards: '11_50'
                      numberOfPayments: More than 20 payments
                      destinationOfFunds: GB
                      mainPurpose: Sale of shares
                      cardFourthLine: CUSTOMER
                      employeeCards: true
                      atmWithdrawals: true
                      annualVolume: Less than £10,000
      security:
        - CommonAuth: []
components:
  securitySchemes:
    CommonAuth:
      type: apiKey
      in: header
      name: Authorization

````