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

# Create a customer

> Create a new customer with explicit onboarding flow selection. Use onboardingFlow: "kyb_link" for third-party verification or onboardingFlow: "direct" for API-managed onboarding.



## OpenAPI

````yaml https://api.conduit.financial/api-docs/2024-12-01/openapi-external.yaml?mode=dynamic post /customers
openapi: 3.0.2
info:
  version: '2024-12-01'
  title: Conduit API
  description: The Conduit Financial API
  contact:
    name: Conduit Support
    email: conduit@conduit.fi
servers:
  - url: https://api.conduit.financial
    description: The Conduit API live environment
  - url: https://api.sandbox.conduit.financial
    description: The Conduit API Sandbox environment
security: []
tags:
  - name: Accounts
    description: |
      Endpoints dealing with accounts.
  - name: Counterparties
    description: |
      Endpoints dealing with counterparties information. 
  - name: Quotes
    description: |
      Endpoints dealing with quotes.
  - name: Transactions
    description: |
      Endpoints dealing with transactions.
  - name: Documents
    description: |
      Endpoints dealing with documents.
  - name: Customers
    description: |
      Endpoints dealing with customer information. 
paths:
  /customers:
    post:
      tags:
        - Customers
      summary: Create a customer
      description: >-
        Create a new customer with explicit onboarding flow selection. Use
        onboardingFlow: "kyb_link" for third-party verification or
        onboardingFlow: "direct" for API-managed onboarding.
      operationId: createCustomer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
            examples:
              Direct Onboarding:
                summary: Direct Onboarding (API-first)
                value:
                  businessLegalName: Acme Corp
                  country: USA
                  onboardingFlow: direct
                  businessInformation:
                    hasDBA: false
                    businessDescription: Provider of industrial widgets and services
                    isSubsidiary: false
                    entityType: Bank
                    isOperating: true
                    regulatorName: FinCEN (Financial Crimes Enforcement Network)
                    businessEntityType: Corporation
                    registeredDate: '2024-01-01'
                    website: https://acme.com
                    email: contact@acme.com
                    phone: '+1234567890'
                    industry: MSB/Payments Company
                    taxIdentificationNumber: '123456789'
                    businessEntityId: BE001
                    naicsCode: NAIS001
                    isFinancialInstitution: false
                    registeredAddress:
                      streetLine1: 123 Business St
                      city: New York
                      state: NY
                      postalCode: '10001'
                      country: USA
                    operatingAddress:
                      streetLine1: 456 Office Ave
                      city: New York
                      state: NY
                      postalCode: '10002'
                      country: USA
                    isStockExchangeListed: false
                    accountPurpose: Payroll/ Employee Payouts
                    highRiskIndustry: Third-party / OBO payments
                    highRiskIndustryDetails: >-
                      We facilitate payments for gig economy platforms,
                      primarily for food delivery and ride-sharing services.
                    hasNestedFlows: true
                    nestedFlowDescription: >-
                      We manage escrow accounts for multiple vendors and process
                      vendor payouts on behalf of our platform customers.
                    certifiesOwnTreasuryUse: true
                    keyGeographicBusinessCountries:
                      - USA
                      - CAN
                    anticipatedTransactionsVolume: 1500
                    usesBlockChainWallets: false
                    anticipatedMonthlyVolume: 50000
                    expectedAverageDailyBalance: 250000
                    sourceOfFunds: Revenue From Products/Services
                    productsOrServices:
                      - Cross-Border Payments
                    isGeneratingRevenues: true
                    revenueCoverage: More than 50% of expenses and growing
                    hasInstitutionalInvestors: true
                    runwayDurationMonths: More than 12 months
                    cashOnHandUsd: 500000
                    hasUsBankAccount: true
                    deniedUsBankAccount:
                      answer: true
                      explanation: >-
                        Application was denied by XYZ Bank in 2022 due to
                        insufficient documentation at the time.
                    businessAuditHistory:
                      answer: true
                      explanation: >-
                        Underwent tax audit by HMRC in 2021, resolved with no
                        outstanding issues.
                    ownersAuditHistory:
                      answer: false
                      explanation: No owners audit history
                    pepInvolved:
                      answer: false
                      explanation: No PEP involvement
                    hasAdvisor: true
                    flowOfFundsDescription: >-
                      Funds are collected from customers via payment processing
                      and disbursed to vendors and suppliers.
                    termsOfServiceAcceptance:
                      date: '2025-07-28'
                      ipAddress: 201.221.240.218
                      isAuthenticated: true
              Hosted Onboarding:
                summary: Hosted Onboarding (KYB Link)
                value:
                  businessLegalName: Acme Corporation Inc.
                  country: USA
                  onboardingFlow: kyb_link
      responses:
        '201':
          description: Customer created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerResponse'
              examples:
                Direct Onboarding:
                  summary: Direct Onboarding Response
                  value:
                    onboardingFlow: direct
                    id: cus_2ofTA13AD0xBtbEvBl20aEb1hEu
                    status: created
                    businessLegalName: Example Business
                Hosted Onboarding:
                  summary: Hosted Onboarding Response
                  value:
                    onboardingFlow: kyb_link
                    id: cus_2ofTA13AD0xBtbEvBl20aEb1hEu
                    kybLink: https://example.com/kyb/verify/abc123
                    kybLinkExpiration: '2024-12-31T23:59:59Z'
                    businessLegalName: Example Business
        '400':
          description: Input validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorResponse'
        '415':
          description: Unsupported media type error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMediaTypeErrorResponse'
        '429':
          description: Throttling error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsErrorResponse'
        '500':
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - apiKey: []
          apiSecret: []
components:
  schemas:
    CreateCustomerRequest:
      oneOf:
        - $ref: '#/components/schemas/DirectCreateCustomerRequest'
        - $ref: '#/components/schemas/KybLinkCreateCustomerRequest'
      discriminator:
        propertyName: onboardingFlow
        mapping:
          direct:
            $ref: '#/components/schemas/DirectCreateCustomerRequest'
          kyb_link:
            $ref: '#/components/schemas/KybLinkCreateCustomerRequest'
      description: Create Customer Request
      example:
        businessLegalName: Acme Corp
        country: USA
        onboardingFlow: direct
        businessInformation:
          hasDBA: false
          businessDescription: Provider of industrial widgets and services
          isSubsidiary: false
          entityType: Bank
          isOperating: true
          regulatorName: FinCEN (Financial Crimes Enforcement Network)
          businessEntityType: Corporation
          anticipatedMonthlyVolume: 50000
          expectedAverageDailyBalance: 250000
          registeredDate: '2024-01-01'
          website: https://acme.com
          email: contact@acme.com
          phone: '+1234567890'
          industry: MSB/Payments Company
          taxIdentificationNumber: '123456789'
          businessEntityId: BE001
          naicsCode: NAIS001
          isFinancialInstitution: false
          registeredAddress:
            streetLine1: 123 Business St
            city: New York
            state: NY
            postalCode: '10001'
            country: USA
          operatingAddress:
            streetLine1: 456 Office Ave
            city: New York
            state: NY
            postalCode: '10002'
            country: USA
          isStockExchangeListed: false
          accountPurpose: Payments for Goods or Services
          accountPurposeDescription: Payment processing for e-commerce transactions and vendor payouts
          highRiskIndustry: Third-party / OBO payments
          highRiskIndustryDetails: >-
            We facilitate payments for gig economy platforms, primarily for food
            delivery and ride-sharing services.
          hasNestedFlows: true
          nestedFlowDescription: >-
            We manage escrow accounts for multiple vendors and process vendor
            payouts on behalf of our platform customers.
          certifiesOwnTreasuryUse: true
          keyGeographicBusinessCountries:
            - USA
            - CAN
          anticipatedTransactionsVolume: 1500
          usesBlockChainWallets: false
          sourceOfFunds: Revenue From Products/Services
          productsOrServices:
            - Cross-Border Payments
          isGeneratingRevenues: true
          revenueCoverage: More than 50% of expenses and growing
          hasInstitutionalInvestors: true
          runwayDurationMonths: More than 12 months
          cashOnHandUsd: 500000
          hasUsBankAccount: true
          deniedUsBankAccount:
            answer: true
            explanation: >-
              Application was denied by XYZ Bank in 2022 due to insufficient
              documentation at the time.
          businessAuditHistory:
            answer: true
            explanation: >-
              Underwent tax audit by HMRC in 2021, resolved with no outstanding
              issues.
          ownersAuditHistory:
            answer: false
            explanation: No owners audit history
          pepInvolved:
            answer: false
            explanation: No PEP involvement
          hasAdvisor: true
          flowOfFundsDescription: >-
            Funds are collected from customers via payment processing and
            disbursed to vendors and suppliers.
          termsOfServiceAcceptance:
            date: '2025-07-28'
            ipAddress: 201.221.240.218
            isAuthenticated: true
    CreateCustomerResponse:
      oneOf:
        - $ref: '#/components/schemas/CreateCustomerKybLinkResponse'
        - $ref: '#/components/schemas/CreateCustomerDirectResponse'
      discriminator:
        propertyName: onboardingFlow
        mapping:
          kyb_link:
            $ref: '#/components/schemas/CreateCustomerKybLinkResponse'
          direct:
            $ref: '#/components/schemas/CreateCustomerDirectResponse'
      description: >-
        Customer creation response. Response shape depends on the onboardingFlow
        used in the request.
    BadRequestErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              code:
                type: string
            required:
              - detail
              - code
      required:
        - errors
    ForbiddenErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              code:
                type: string
            required:
              - detail
              - code
      required:
        - errors
    UnsupportedMediaTypeErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              code:
                type: string
            required:
              - detail
              - code
      required:
        - errors
    TooManyRequestsErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              code:
                type: string
            required:
              - detail
              - code
      required:
        - errors
    InternalServerErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              code:
                type: string
            required:
              - detail
              - code
      required:
        - errors
    DirectCreateCustomerRequest:
      type: object
      properties:
        orgId:
          type: string
        businessLegalName:
          type: string
          minLength: 1
          description: The legal name of the business
        country:
          type: string
          minLength: 3
          maxLength: 3
          description: The country where the business is located
        isSubsidiary:
          type: boolean
        kybSetupBy:
          type: string
          enum:
            - client
        onboardingFlow:
          type: string
          enum:
            - direct
        businessInformation:
          $ref: '#/components/schemas/BusinessInformation'
      required:
        - businessLegalName
        - country
        - onboardingFlow
        - businessInformation
      description: Direct Customer Onboarding Request
      example:
        businessLegalName: Acme Corp
        country: USA
        onboardingFlow: direct
        businessInformation:
          hasDBA: false
          businessDescription: Provider of industrial widgets and services
          isSubsidiary: false
          entityType: Bank
          isOperating: true
          regulatorName: FinCEN (Financial Crimes Enforcement Network)
          businessEntityType: Corporation
          registeredDate: '2024-01-01'
          website: https://acme.com
          email: contact@acme.com
          phone: '+1234567890'
          industry: MSB/Payments Company
          taxIdentificationNumber: '123456789'
          businessEntityId: BE001
          naicsCode: NAIS001
          isFinancialInstitution: false
          registeredAddress:
            streetLine1: 123 Business St
            city: New York
            state: NY
            postalCode: '10001'
            country: USA
          operatingAddress:
            streetLine1: 456 Office Ave
            city: New York
            state: NY
            postalCode: '10002'
            country: USA
          isStockExchangeListed: false
          accountPurpose: Payroll/ Employee Payouts
          highRiskIndustry: Third-party / OBO payments
          highRiskIndustryDetails: >-
            We facilitate payments for gig economy platforms, primarily for food
            delivery and ride-sharing services.
          hasNestedFlows: true
          nestedFlowDescription: >-
            We manage escrow accounts for multiple vendors and process vendor
            payouts on behalf of our platform customers.
          certifiesOwnTreasuryUse: true
          keyGeographicBusinessCountries:
            - USA
            - CAN
          anticipatedTransactionsVolume: 1500
          usesBlockChainWallets: false
          anticipatedMonthlyVolume: 50000
          expectedAverageDailyBalance: 250000
          sourceOfFunds: Revenue From Products/Services
          productsOrServices:
            - Cross-Border Payments
          isGeneratingRevenues: true
          revenueCoverage: More than 50% of expenses and growing
          hasInstitutionalInvestors: true
          runwayDurationMonths: More than 12 months
          cashOnHandUsd: 500000
          hasUsBankAccount: true
          deniedUsBankAccount:
            answer: true
            explanation: >-
              Application was denied by XYZ Bank in 2022 due to insufficient
              documentation at the time.
          businessAuditHistory:
            answer: true
            explanation: >-
              Underwent tax audit by HMRC in 2021, resolved with no outstanding
              issues.
          ownersAuditHistory:
            answer: false
            explanation: No owners audit history
          pepInvolved:
            answer: false
            explanation: No PEP involvement
          hasAdvisor: true
          flowOfFundsDescription: >-
            Funds are collected from customers via payment processing and
            disbursed to vendors and suppliers.
          termsOfServiceAcceptance:
            date: '2025-07-28'
            ipAddress: 201.221.240.218
            isAuthenticated: true
    KybLinkCreateCustomerRequest:
      type: object
      properties:
        orgId:
          type: string
        businessLegalName:
          type: string
          minLength: 1
          description: The legal name of the business
        country:
          type: string
          minLength: 3
          maxLength: 3
          description: The country where the business is located
        isSubsidiary:
          type: boolean
        kybSetupBy:
          type: string
          enum:
            - client
        onboardingFlow:
          type: string
          enum:
            - kyb_link
        businessInformation:
          nullable: true
      required:
        - businessLegalName
        - country
        - onboardingFlow
      description: Hosted KYB Link Onboarding Request
      example:
        businessLegalName: Acme Corporation Inc.
        country: USA
        onboardingFlow: kyb_link
    CreateCustomerKybLinkResponse:
      type: object
      properties:
        onboardingFlow:
          type: string
          enum:
            - kyb_link
        kybLink:
          type: string
          minLength: 1
        kybLinkExpiration:
          type: string
          format: date-time
        id:
          $ref: '#/components/schemas/CustomerId'
        businessLegalName:
          type: string
          minLength: 1
      required:
        - onboardingFlow
        - kybLink
        - kybLinkExpiration
        - id
        - businessLegalName
      description: Customer creation response for KYB link flow
      example:
        onboardingFlow: kyb_link
        id: cus_2ofTA13AD0xBtbEvBl20aEb1hEu
        kybLink: https://example.com/kyb/verify/abc123
        kybLinkExpiration: '2024-12-31T23:59:59Z'
        businessLegalName: Example Business
    CreateCustomerDirectResponse:
      type: object
      properties:
        onboardingFlow:
          type: string
          enum:
            - direct
        id:
          $ref: '#/components/schemas/CustomerId'
        status:
          $ref: '#/components/schemas/PublicCustomerStatus'
        businessLegalName:
          type: string
          minLength: 1
      required:
        - onboardingFlow
        - id
        - status
        - businessLegalName
      description: Customer creation response for direct onboarding flow
      example:
        onboardingFlow: direct
        id: cus_2ofTA13AD0xBtbEvBl20aEb1hEu
        status: created
        businessLegalName: Example Business
    BusinessInformation:
      type: object
      properties:
        hasDBA:
          type: boolean
          description: Does your business operate under a DBA (Doing Business As) name?
        businessTradeName:
          type: string
          description: >-
            Business trade name (DBA name). **Required when `hasDBA` is
            `true`**.
        registeredDate:
          type: string
          minLength: 1
          pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
        website:
          type: string
          minLength: 5
          format: uri
        industry:
          type: string
          enum:
            - General Commercial/Operating Entity
            - Consulting/Advisory
            - Accounting and Auditing
            - Bank/Deposit-Taking Institution
            - Broker-Dealer/Securities Firm
            - Asset Manager/Investment Advisor
            - Private Investment Fund
            - MSB/Payments Company
            - Lending Platform/Credit Provider
            - Credit Card Companies (Issuers & Merchant Services)
            - Marketplace/Platform Operator
            - Insurance Company
            - Legal Services
            - Government Entity/Public Sector
            - Non-Profit/Charity
            - Holding Company/Family Office/Investment Vehicle
            - Trust and Company Service Providers (TCSPs)
            - Casino/Gambling Operator
            - Real Estate Company
            - Precious Metals/Stones
            - Art & Antiquities
            - Crypto/Digital Asset Business (VASP)
            - Travel Agency/Tour Operator
            - Crowd Funding Platform
            - Forex/Currency Exchange Provider
            - Import/Export/Trading Company
            - Freight Forwarding/Shipping Company
            - Pharmaceutical/Healthcare Company
            - Construction/Development Firm
            - Automobile Dealerships
            - Informal Remittance Systems (Hawala, etc)
            - Other
          description: Industry type
        describeIndustry:
          type: string
          description: >-
            Please describe your industry. **Required when `industry` is set to
            `Other`**.
        email:
          type: string
          format: email
        phone:
          type: string
          minLength: 1
          pattern: ^\+[1-9]\d{1,14}$
        taxIdentificationNumber:
          type: string
          minLength: 1
        businessEntityId:
          type: string
          minLength: 1
        isFinancialInstitution:
          type: boolean
        registeredAddress:
          $ref: '#/components/schemas/Address'
        operatingAddress:
          $ref: '#/components/schemas/Address'
        entityType:
          $ref: '#/components/schemas/EntityType'
        mailingAddress:
          $ref: '#/components/schemas/Address'
        isSubsidiary:
          type: boolean
        isOperating:
          type: boolean
        naicsCode:
          type: string
        entityTaxedAs:
          type: string
          enum:
            - LLC
            - Corporation
            - Partnership
            - Sole Proprietor
            - Foundation
            - Cooperative
            - Government Entity
            - Nonprofit
            - Trust
            - Other
        anticipatedMonthlyVolume:
          type: number
          description: Anticipated average monthly transaction volume (USD)
        expectedAverageDailyBalance:
          type: number
          description: Expected average daily balance (USD)
        taxClassification:
          type: string
        regulatorName:
          type: string
          enum:
            - FinCEN (Financial Crimes Enforcement Network)
            - FCA (Financial Conduct Authority)
            - >-
              FINTRAC (Financial Transactions and Reports Analysis Centre of
              Canada)
            - Local FIUs + National regulators (e.g., BaFin, ACPR, CNMV)
            - MAS (Monetary Authority of Singapore)
            - AUSTRAC (Australian Transaction Reports and Analysis Centre)
            - FSA (Financial Services Agency)
            - FINMA (Swiss Financial Market Supervisory Authority)
            - HKMA (Hong Kong Monetary Authority)
            - FSRA (Financial Services Regulatory Authority)
            - CNBV (Comisión Nacional Bancaria y de Valores)
            - BACEN (Central Bank of Brazil)
            - RBI (Reserve Bank of India)
            - FSCA (Financial Sector Conduct Authority)
            - SEC Nigeria (Securities and Exchange Commission - Nigeria)
            - CBK (Central Bank of Kenya)
            - BSP (Bangko Sentral ng Pilipinas)
            - UIAF (Unidad de Información y Análisis Financiero)
            - UIF Argentina
            - BNM (Bank Negara Malaysia)
            - OJK (Financial Services Authority of Indonesia)
            - SECP (Securities and Exchange Commission Pakistan)
            - BoG (Bank of Ghana)
            - MASAK (Financial Crimes Investigation Board)
            - Superintendencia de Bancos
            - FSC (Financial Services Commission)
            - DFSA (Dubai Financial Services Authority)
            - >-
              COAF – Conselho de Controle de Atividades Financeiras (Financial
              Intelligence Unit for AML)
            - FIU-IND (Financial Intelligence Unit – India)
            - >-
              CBN (Central Bank of Nigeria – regulator for banks and payments
              institutions)
            - FRC Kenya (Financial Reporting Centre)
            - AMLC (Anti-Money Laundering Council – Philippines)
            - FIC (Financial Intelligence Centre – Ghana)
            - UIF (Unidad de Inteligencia Financiera)
            - CIMA (Cayman Islands Monetary Authority)
            - SBP (State Bank of Pakistan)
            - Other
          description: >-
            Regulatory authority overseeing this financial institution.
            **Required when `isFinancialInstitution` is `true`**.
        regulatoryAuthorityOther:
          type: string
          description: >-
            Please provide "Other" regulatory body. **Required when
            `regulatorName` is set to `Other`**.
        regulatoryLicenseNumber:
          type: string
          description: >-
            License Number or Registration ID. **Required when
            `isFinancialInstitution` is `true`**.
        hasAdvisor:
          type: boolean
        businessDescription:
          type: string
          minLength: 5
        businessEntityType:
          type: string
          enum:
            - LLC
            - Corporation
            - Partnership
            - Sole Proprietor
            - Foundation
            - Cooperative
            - Government Entity
            - Nonprofit
            - Trust
            - Other
        isStockExchangeListed:
          type: boolean
          description: Is your company publicly listed on a recognized stock exchange?
        stockExchange:
          type: string
          enum:
            - NASDAQ (U.S.)
            - NYSE (New York Stock Exchange)
            - LSE (London Stock Exchange)
            - TSX (Toronto Stock Exchange)
            - SIX Swiss Exchange
            - Euronext (Paris, Amsterdam, Brussels)
            - Deutsche Börse (Frankfurt)
            - HKEX (Hong Kong Exchange)
            - SGX (Singapore Exchange)
            - ASX (Australian Securities Exchange)
            - TSE (Tokyo Stock Exchange)
            - Other
          description: >-
            Which stock exchange is your company listed on? **Required when
            `isStockExchangeListed` is `true`**.
        stockExchangeOther:
          type: string
          description: >-
            Please specify the stock exchange. **Required when `stockExchange`
            is set to `Other`**.
        tickerSymbol:
          type: string
          description: >-
            What is your company's ticker symbol? **Required when
            `isStockExchangeListed` is `true`**.
        accountPurpose:
          type: string
          enum:
            - Payroll/ Employee Payouts
            - Payments for Goods or Services
            - Marketplace/ Gig Worker Payouts
            - Internal Treasury or FX Management
            - Disbursement of Customer Funds
          description: What is the purpose of this account with Conduit
        accountPurposeDescription:
          type: string
          description: >-
            Please describe the goods or services you intend to pay for using
            this account. **Required when `accountPurpose` is set to `Payments
            for Goods or Services`**.
        highRiskIndustry:
          type: string
          enum:
            - Third-party / OBO payments
            - Gambling / Betting
            - Adult Services / Content
            - Cannabis / Regulated Substances
            - NPO / Charity / Political
            - Cash-intensive Retail
            - Weapons / Arms
            - Shell Company
            - Offshore Structure
            - Precious Metals / Stones
            - Art / Antiques / High-Value Collectibles
            - Forex / Currency Exchange
            - Trust & Company Services
            - None of the above
          description: >-
            Does your company operate in or have exposure to high-risk
            industries?
        highRiskIndustryDetails:
          type: string
          description: >-
            Please provide additional details about your business activities in
            the selected high risk industries. **Required when
            `highRiskIndustry` is not `None`**.
        hasNestedFlows:
          type: boolean
          description: Do you operate or transact on behalf of customers or third parties?
        nestedFlowDescription:
          type: string
          description: >-
            Please briefly describe the types of accounts or flows you manage.
            **Required when `hasNestedFlows` is `true`**.
        certifiesOwnTreasuryUse:
          type: boolean
          description: >-
            Certification that accounts will not be used to process or hold
            third-party or customer funds without written approval
        keyGeographicBusinessCountries:
          type: array
          items:
            type: string
            minLength: 3
            maxLength: 3
            description: The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
          description: >-
            In which countries do you anticipate conducting 20%+ of your
            business?
        anticipatedTransactionsVolume:
          type: number
          description: Estimated Number of Transactions per Month
        usesBlockChainWallets:
          type: boolean
          description: Will your company use blockchain wallet addresses?
        blockchainWallets:
          type: array
          items:
            type: object
            properties:
              walletAddress:
                type: string
                minLength: 1
              associatedPlatformType:
                type: string
                enum:
                  - exchange
                  - custodian
                  - platform
                  - self_custodied
                description: Type of platform associated with the wallet address
              associatedPlatformName:
                type: string
                minLength: 1
                description: Name of the exchange, custodian, or platform
            required:
              - walletAddress
              - associatedPlatformType
              - associatedPlatformName
          description: >-
            List of blockchain wallet addresses (deposit, withdrawal,
            settlement) your company expects to use. **Required when
            `usesBlockChainWallets` is `true`**.
        sourceOfFunds:
          type: string
          enum:
            - Revenue From Products/Services
            - Venture Capital (VC)/Private Equity
            - Friends & Family Funding
            - Personal Savings of Founders
            - Loans or Credit Facilities
            - Grants or Government Funding
          description: Source of Funds (Primary Driver)
        productsOrServices:
          type: array
          items:
            type: string
            enum:
              - Technology / SaaS Provider
              - Sale of Goods / Non-Financial Services
              - Import / Export
              - Wholesale / Distribution
              - Investment Advisory
              - Digital Wallets / Stored Value
              - Custody
              - Lending / Credit
              - Escrow / Settlement Services
              - Crypto Exchange or Trading
              - Cross-Border Payments
              - NFT / DeFi / Web3
              - Foreign Exchange / Currency Conversion
              - Card Issuance & Merchant Services
              - Brokerage / Trading Platform
              - Asset Management / Fund Services
              - Precious Metals / High-Value Commodities
              - Marketplace or Platform Operator
              - Real Estate / Title / Property Escrow
              - Crowdfunding / Capital Raising Platforms
              - Trust and Company Services (TCSP)
          minItems: 1
          description: What products or services does your company offer?
        isGeneratingRevenues:
          type: boolean
          description: Are you currently generating revenue?
        revenueCoverage:
          type: string
          enum:
            - More than 50% of expenses and growing
            - Between 50% and 25% of expenses and growing
            - Less than 25% of expenses
          description: >-
            If yes, revenue covers. **Required when `isGeneratingRevenues` is
            `true`**.
        revenueCoverageExplanation:
          type: string
          description: >-
            Please provide a brief explanation (e.g., upcoming fundraise, cash
            injection expected, cost-cutting plans). **Required when
            `revenueCoverage` is set to `Less than 25% of expenses`**.
        hasInstitutionalInvestors:
          type: boolean
          description: Does your company have institutional investors (VC or PE)?
        runwayDurationMonths:
          type: string
          enum:
            - More than 12 months
            - Between 6 - 12 months
            - Less than 6 months
            - N/A due to Profitability or no burn
          description: How many months of financial runway do you currently have?
        runwayDurationExplanation:
          type: string
          description: >-
            Please provide a brief explanation for financial runway (e.g.,
            upcoming fundraise, cash injection expected, cost-cutting plans).
            **Required when `runwayDurationMonths` is less than 12 months**.
        cashOnHandUsd:
          type: number
          description: What is your company's current cash on hand?
        hasUsBankAccount:
          type: boolean
          description: Do you have an existing, active US Bank account?
        deniedUsBankAccount:
          type: object
          properties:
            answer:
              type: boolean
              description: Have you ever been denied a US Bank Account?
            explanation:
              type: string
              description: If yes, provide explanation
          required:
            - answer
          description: >-
            Information about denied US bank account. **Required when
            `hasUsBankAccount` is `false`**.
        businessAuditHistory:
          type: object
          properties:
            answer:
              type: boolean
              description: >-
                Has the business ever been subject to one of the following:
                Audit by Tax Authority (US or non-US), Audit by Government or
                Regulatory Agency (US or non-US), Review by Government or
                Regulatory Agency (US or non-US),Law Enforcement Action, Search
                & Seizure of Assets, Other negative interaction(s) that would
                result in harm to the reputation of the business or its owners?
            explanation:
              type: string
              description: If yes, provide details
          required:
            - answer
          description: Business audit history information
        ownersAuditHistory:
          type: object
          properties:
            answer:
              type: boolean
              description: >-
                Have any of the owners, directors or officers of the business
                ever been subject to one of the following: Personal audit by Tax
                Authority (US or non-US), Personal audit by Government or
                Regulatory Agency (US or non-US), Regulatory sanctions, Law
                Enforcement Action, Search & Seizure of Assets, Other negative
                interaction(s) that would result in harm to the reputation of
                the business or its owners?
            explanation:
              type: string
              description: If yes, provide details
          required:
            - answer
          description: Business owners audit history information
        pepInvolved:
          type: object
          properties:
            answer:
              type: boolean
              description: >-
                Are any of the owners, directors, or officers of the business
                considered a Politically Exposed Person (PEP)?
            explanation:
              type: string
              description: If yes, provide details
          required:
            - answer
          description: Politically Exposed Person involvement information
        hasIndependentAmlAuditReport:
          type: object
          properties:
            answer:
              type: boolean
              description: >-
                Does your company have an independent AML or Compliance Program
                Audit Report?
            explanation:
              type: string
              description: >-
                Please explain why an independent AML or Compliance Program
                Audit has not been conducted
            timeline:
              type: string
              description: >-
                Please confirm if you are intending to obtain one and provide
                the expected timeline
          required:
            - answer
          description: >-
            Independent AML or Compliance Program Audit Report information.
            **Required when `isFinancialInstitution` is `true`**.
        flowOfFundsDescription:
          type: string
          description: >-
            For compliance purposes, please describe your company's fund flow -
            how funds are collected, processed, and disbursed across relevant
            accounts or partners. **Required when `isFinancialInstitution` is
            `false`**.
        termsOfServiceAcceptance:
          $ref: '#/components/schemas/TermsOfServiceAcceptance'
      required:
        - hasDBA
        - registeredDate
        - website
        - industry
        - email
        - phone
        - taxIdentificationNumber
        - businessEntityId
        - isFinancialInstitution
        - registeredAddress
        - operatingAddress
        - isSubsidiary
        - isOperating
        - anticipatedMonthlyVolume
        - expectedAverageDailyBalance
        - businessDescription
        - businessEntityType
        - isStockExchangeListed
        - accountPurpose
        - highRiskIndustry
        - hasNestedFlows
        - certifiesOwnTreasuryUse
        - keyGeographicBusinessCountries
        - anticipatedTransactionsVolume
        - usesBlockChainWallets
        - sourceOfFunds
        - productsOrServices
        - isGeneratingRevenues
        - hasInstitutionalInvestors
        - runwayDurationMonths
        - cashOnHandUsd
        - termsOfServiceAcceptance
      description: >-
        Basic business information required for customer creation.


        **Conditional Field Requirements:**

        - `businessTradeName`: Required when `hasDBA` is `true`

        - `describeIndustry`: Required when `industry` is `Other`

        - `regulatorName`, `regulatoryLicenseNumber`,
        `hasIndependentAmlAuditReport`: Required when `isFinancialInstitution`
        is `true`

        - `regulatoryAuthorityOther`: Required when `regulatorName` is `Other`

        - `flowOfFundsDescription`: Required when `isFinancialInstitution` is
        `false`

        - `stockExchange` and `tickerSymbol`: Required when
        `isStockExchangeListed` is `true`

        - `stockExchangeOther`: Required when `stockExchange` is `Other`

        - `accountPurposeDescription`: Required when `accountPurpose` is
        `Payments for Goods or Services`

        - `highRiskIndustryDetails`: Required when `highRiskIndustry` is not
        `None`

        - `nestedFlowDescription`: Required when `hasNestedFlows` is `true`

        - `blockchainWallets`: Required when `usesBlockChainWallets` is `true`

        - `revenueCoverage`: Required when `isGeneratingRevenues` is `true`

        - `revenueCoverageExplanation`: Required when `revenueCoverage` is `Less
        than 25% of expenses`

        - `runwayDurationExplanation`: Required when `runwayDurationMonths` is
        less than 12 months

        - `deniedUsBankAccount`: Required when `hasUsBankAccount` is `false`


        See individual field descriptions for more details.
      example:
        hasDBA: false
        businessTradeName: Acme Corp
        industry: Forex/Currency Exchange Provider
        entityType: Bank
        website: https://acme.com
        registeredDate: '2024-01-01'
        email: contact@acme.com
        phone: '+1234567890'
        taxIdentificationNumber: '123456789'
        taxClassification: LLC
        businessEntityId: BE001
        naicsCode: NAIS001
        isFinancialInstitution: false
        registeredAddress:
          streetLine1: 123 Business St
          streetLine2: Suite 100
          city: New York
          state: NY
          postalCode: '10001'
          country: USA
        operatingAddress:
          streetLine1: 456 Office Ave
          city: New York
          state: NY
          postalCode: '10002'
          country: USA
        mailingAddress:
          streetLine1: 789 Mailing Rd
          city: New York
          state: NY
          postalCode: '10003'
          country: USA
        isSubsidiary: false
        isOperating: true
        entityTaxedAs: Corporation
        anticipatedMonthlyVolume: 100000
        expectedAverageDailyBalance: 250000
        regulatorName: FinCEN (Financial Crimes Enforcement Network)
        regulatoryLicenseNumber: FIN-2024-12345
        hasAdvisor: true
        businessDescription: Provider of industrial widgets and services
        hasIndependentAmlAuditReport:
          answer: false
          explanation: >-
            Our company was incorporated recently and is in the process of
            establishing formal compliance procedures.
          timeline: >-
            We plan to engage an independent auditor within the next 6 months to
            conduct our first AML compliance audit.
        businessEntityType: Corporation
        isStockExchangeListed: false
        accountPurpose: Payroll/ Employee Payouts
        highRiskIndustry: Third-party / OBO payments
        highRiskIndustryDetails: >-
          We facilitate payments for gig economy platforms, primarily for food
          delivery and ride-sharing services.
        hasNestedFlows: true
        nestedFlowDescription: >-
          We manage escrow accounts for multiple vendors and process vendor
          payouts on behalf of our platform customers.
        certifiesOwnTreasuryUse: true
        keyGeographicBusinessCountries:
          - USA
          - CAN
        anticipatedTransactionsVolume: 1500
        usesBlockChainWallets: true
        blockchainWallets:
          - walletAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'
            associatedPlatformType: exchange
            associatedPlatformName: Binance
          - walletAddress: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
            associatedPlatformType: custodian
            associatedPlatformName: Fireblocks
          - walletAddress: TNVp4w8jH8J9Z6G1B5Q4R8P7K6J5H3D2F1
            associatedPlatformType: self_custodied
            associatedPlatformName: Company Treasury Wallet
        sourceOfFunds: Venture Capital (VC)/Private Equity
        productsOrServices:
          - Technology / SaaS Provider
          - Sale of Goods / Non-Financial Services
        isGeneratingRevenues: true
        revenueCoverage: More than 50% of expenses and growing
        hasInstitutionalInvestors: true
        runwayDurationMonths: More than 12 months
        cashOnHandUsd: 500000
        flowOfFundsDescription: >-
          Funds are collected from institutional clients via wire transfers,
          processed through our custody accounts, and disbursed to beneficiaries
          via ACH and wire transfers based on client instructions.
        termsOfServiceAcceptance:
          date: '2025-07-28'
          ipAddress: 201.221.240.218
          isAuthenticated: true
    CustomerId:
      type: string
      pattern: ^cus_[a-zA-Z0-9]{27}$
      description: A valid Customer ID
      example: cus_2ofTA13AD0xBtbEvBl20aEb1hEu
    PublicCustomerStatus:
      type: string
      enum:
        - active
        - in_compliance_review
        - compliance_rejected
        - created
        - kyb_in_progress
        - kyb_expired
        - kyb_missing_information
        - account_onboarding_pending
        - failed_to_create
    Address:
      type: object
      properties:
        streetLine1:
          type: string
          minLength: 1
        streetLine2:
          type: string
        city:
          type: string
          minLength: 1
          pattern: '^[A-Za-zÀ-ÖØ-öø-ÿ''''.-]+(?: [A-Za-zÀ-ÖØ-öø-ÿ''''.-]+)*$'
        state:
          type: string
          pattern: ^[A-Za-zÀ-ÖØ-öø-ÿ0-9''.-](?:[A-Za-zÀ-ÖØ-öø-ÿ0-9''.\- ]{0,})$
        postalCode:
          type: string
        country:
          type: string
          minLength: 3
          maxLength: 3
          description: The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
      required:
        - streetLine1
        - city
        - country
      description: Address information
      example:
        streetLine1: 123 Main St
        streetLine2: Suite 100
        city: New York
        state: NY
        postalCode: '10001'
        country: USA
    EntityType:
      type: string
      enum:
        - Bank
        - Insurance Company
        - Securities Broker or Dealer
        - Investment Company or other Passive Investment Vehicle
        - Trust Company
        - Hedge Fund
        - Other
    TermsOfServiceAcceptance:
      type: object
      properties:
        date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        ipAddress:
          type: string
          minLength: 1
        isAuthenticated:
          type: boolean
          description: >-
            Whether the user was authenticated when accepting the terms of
            service
      required:
        - date
        - ipAddress
        - isAuthenticated
      description: Terms of service acceptance information
      example:
        date: '2025-07-28'
        ipAddress: 201.221.240.218
        isAuthenticated: true
  securitySchemes:
    apiKey:
      type: apiKey
      description: Includes an API key in the HTTP headers to authenticate the client.
      name: X-API-Key
      in: header
    apiSecret:
      type: apiKey
      description: Includes an API secret in the HTTP headers to authenticate the client.
      name: X-API-Secret
      in: header

````