> ## 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.

# Get a customer by ID

> Retrieves the full details of a single customer, including their business or individual profile and active features.



## OpenAPI

````yaml https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{id}
openapi: 3.0.0
info:
  title: Conduit Sandbox API
  description: >-
    **Sandbox API** — clients integrate against this surface to exercise happy
    and unhappy paths without consuming real KYC/PSP credits or moving real
    money. Customer KYC, banking partners, and crypto custody are stubbed;
    org-level KYB runs against real providers. Simulation endpoints under
    `/v2/sandbox/*` drive specific scenarios.


    Internal and portal endpoints are excluded from this spec.
  version: '2.0'
  contact: {}
servers:
  - url: https://api.sandbox.conduit.financial/v2
    description: Sandbox
  - url: https://api.conduit.financial/v2
    description: Production
security:
  - api-key: []
tags:
  - name: Customers
  - name: Registered Addresses
  - name: Wallets
  - name: Wallet Signers
  - name: Signing Quorum
  - name: Virtual Accounts
  - name: Applications
  - name: RFIs
  - name: Documents
  - name: Verifications
  - name: Signing Requests
  - name: Transactions
  - name: Payouts
  - name: Whitelist Recipients
  - name: Orders
  - name: Asset Chain Pairs
  - name: Quotes
  - name: Webhook Endpoints
  - name: Webhook Deliveries
  - name: Webhook Event Types
  - name: Features
  - name: Customer Onboarding
  - name: Markup
  - name: Sandbox
paths:
  /customers/{id}:
    get:
      tags:
        - Customers
      summary: Get a customer by ID
      description: >-
        Retrieves the full details of a single customer, including their
        business or individual profile and active features.
      operationId: CustomersController_findById_v2
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
            example: cus_1A2b3C4d5E6f7G8h9I0jKl
      responses:
        '200':
          description: The requested customer
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/BusinessCustomerResponseDto'
                  - $ref: '#/components/schemas/IndividualCustomerResponseDto'
                discriminator:
                  propertyName: type
                  mapping:
                    business: '#/components/schemas/BusinessCustomerResponseDto'
                    individual: '#/components/schemas/IndividualCustomerResponseDto'
        '400':
          description: >-
            **INVALID_OID_FORMAT**: A path or query parameter expected a valid
            object identifier but received a value that does not match the
            expected format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorDto'
              example:
                type: INVALID_OID_FORMAT
                title: Invalid Object ID Format
                status: 400
                detail: >-
                  A path or query parameter expected a valid object identifier
                  but received a value that does not match the expected format.
                resolution: >-
                  Verify that all IDs in the request URL and query parameters
                  are correctly formatted. IDs are typically prefixed strings
                  like 'cus_...', 'app_...', or 'doc_...'.
                docs: https://conduit-v2.mintlify.app/errors#invalid-oid-format
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
        '401':
          description: >-
            **API_KEY_MISSING**: The request did not include an API key. All API
            requests must be authenticated.


            **API_KEY_INVALID**: The provided API key is not recognized or has
            been revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailDto'
              example:
                type: API_KEY_MISSING
                title: API Key Missing
                status: 401
                detail: >-
                  The request did not include an API key. All API requests must
                  be authenticated.
                resolution: >-
                  Include your API key in the 'x-api-key' header with every
                  request.
                docs: https://conduit-v2.mintlify.app/errors#api-key-missing
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
        '403':
          description: >-
            **ORGANIZATION_ACCESS_SUSPENDED**: Conduit has suspended this
            organization's access. Requests with the organization's API keys and
            from its users are refused until Conduit restores access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailDto'
              example:
                type: ORGANIZATION_ACCESS_SUSPENDED
                title: Organization Access Suspended
                status: 403
                detail: >-
                  Conduit has suspended this organization's access. Requests
                  with the organization's API keys and from its users are
                  refused until Conduit restores access.
                resolution: Contact Conduit support.
                docs: >-
                  https://conduit-v2.mintlify.app/errors#organization-access-suspended
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
        '404':
          description: >-
            **CUSTOMER_NOT_FOUND**: No customer exists with the specified ID, or
            the customer belongs to a different organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailDto'
              example:
                type: CUSTOMER_NOT_FOUND
                title: Customer Not Found
                status: 404
                detail: >-
                  No customer exists with the specified ID, or the customer
                  belongs to a different organization.
                resolution: >-
                  Verify the customer ID is correct. Use the list customers
                  endpoint to find valid customer IDs for your organization.
                docs: https://conduit-v2.mintlify.app/errors#customer-not-found
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
        '429':
          description: >-
            **RATE_LIMITED**: Too many requests. This error is returned by three
            independent checks: the per-organization bucket applied to every
            authenticated API request; the per-IP bucket applied to
            unauthenticated traffic before an API key is validated; and the
            per-IP bucket applied when repeated invalid API keys are submitted
            from the same address. Honor the Retry-After header (also exposed as
            retryAfterSeconds in the body) before retrying. Current limits and
            remaining budget are visible in X-RateLimit-Limit (the bucket size),
            X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the
            bucket refills) on every response once your API key is accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedErrorDto'
              example:
                type: RATE_LIMITED
                title: Rate Limited
                status: 429
                detail: >-
                  Too many requests. This error is returned by three independent
                  checks: the per-organization bucket applied to every
                  authenticated API request; the per-IP bucket applied to
                  unauthenticated traffic before an API key is validated; and
                  the per-IP bucket applied when repeated invalid API keys are
                  submitted from the same address. Honor the Retry-After header
                  (also exposed as retryAfterSeconds in the body) before
                  retrying. Current limits and remaining budget are visible in
                  X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining,
                  and X-RateLimit-Reset (seconds until the bucket refills) on
                  every response once your API key is accepted.
                resolution: >-
                  Sleep until Retry-After seconds have elapsed, then retry. For
                  sustained workloads exceeding the per-organization defaults,
                  request a rate-limit increase through your support contact.
                docs: https://conduit-v2.mintlify.app/errors#rate-limited
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
                retryAfterSeconds: 3
        '500':
          description: >-
            **INTERNAL_ERROR**: An unexpected error occurred while processing
            your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailDto'
              example:
                type: INTERNAL_ERROR
                title: Internal Error
                status: 500
                detail: An unexpected error occurred while processing your request.
                resolution: >-
                  Retry the request after a brief delay. If the error persists,
                  contact support and include the correlationId from the error
                  response for investigation.
                docs: https://conduit-v2.mintlify.app/errors#internal-error
                instance: /v2/...
                correlationId: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
                timestamp: '2026-01-15T09:30:00.000Z'
components:
  schemas:
    BusinessCustomerResponseDto:
      type: object
      properties:
        id:
          type: string
          pattern: ^cus_[0-9A-Za-z]{22}$
          description: Unique customer identifier
        clientReferenceId:
          description: >-
            Client-provided external identifier for cross-referencing. 1-255
            characters from A-Za-z, 0-9, underscore, hyphen, colon, and period —
            no spaces.
          example: client-cus-001
          type: string
          pattern: ^[A-Za-z0-9_\-:.]{1,255}$
        applicationId:
          type: string
          pattern: ^app_[0-9A-Za-z]{22}$
          description: ID of the onboarding application that created this customer.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the customer was created
          example: '2026-01-15T09:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the customer was last modified
          example: '2026-01-15T09:30:00.000Z'
        features:
          type: array
          items:
            type: object
            properties:
              feature:
                description: Feature identifier
                type: string
                enum:
                  - virtual_account
                  - crypto_wallet
              isActive:
                type: boolean
                description: Whether this feature is currently active for the customer
                example: true
            required:
              - feature
              - isActive
          description: List of features enabled for this customer
        isHouseAccount:
          type: boolean
          description: >-
            Whether this customer is the organization's own house account rather
            than an external customer. Read-only on live; on sandbox, set it
            with `PATCH /v2/sandbox/customers/{customerId}/house-account`.
          example: false
        signingMode:
          description: >-
            Effective signing mode for this customer right now: the per-customer
            override if one exists, else the organization setting, else the
            default. For a customer with no wallet claim yet, this is the value
            `claim-non-custodial` would freeze and the roster shape it accepts.
            For a customer that already claimed, the claimed wallet keeps the
            mode it froze at claim time, even if this value changes afterward.
            This field may be absent temporarily while the API is being updated.
          type: string
          enum:
            - passkey_required
            - programmatic
            - programmatic_unattended
        type:
          type: string
          enum:
            - business
        legalName:
          type: string
          description: Registered legal name of the business
          example: Acme Payments Inc.
        tradeName:
          description: Doing-business-as name. Omitted if same as legal name.
          example: Acme Pay
          type: string
        registrationNumber:
          description: Business registration or incorporation number
          example: '12345678'
          type: string
        taxId:
          type: string
          description: >-
            Government-issued tax identifier (e.g. EIN for US businesses). A US
            EIN captured from this release on is returned as nine digits without
            hyphens; an EIN stored earlier keeps the form it was stored in.
          example: '123456789'
        registeredAddress:
          type: object
          properties:
            addressLine1:
              type: string
              description: Primary street address
              example: 100 Market St
            addressLine2:
              description: Secondary address line (suite, floor, etc.)
              example: Suite 400
              type: string
            city:
              type: string
              description: City
              example: San Francisco
            state:
              description: State or province
              example: CA
              type: string
            postalCode:
              description: Postal code
              example: '94105'
              type: string
            country:
              type: string
              enum:
                - AF
                - AL
                - DZ
                - AS
                - AD
                - AO
                - AI
                - AQ
                - AG
                - AR
                - AM
                - AW
                - AU
                - AT
                - AZ
                - BS
                - BH
                - BD
                - BB
                - BY
                - BE
                - BZ
                - BJ
                - BM
                - BT
                - BO
                - BQ
                - BA
                - BW
                - BV
                - BR
                - IO
                - BN
                - BG
                - BF
                - BI
                - CV
                - KH
                - CM
                - CA
                - KY
                - CF
                - TD
                - CL
                - CN
                - CX
                - CC
                - CO
                - KM
                - CG
                - CD
                - CK
                - CR
                - CI
                - HR
                - CU
                - CW
                - CY
                - CZ
                - DK
                - DJ
                - DM
                - DO
                - EC
                - EG
                - SV
                - GQ
                - ER
                - EE
                - SZ
                - ET
                - FK
                - FO
                - FJ
                - FI
                - FR
                - GF
                - PF
                - TF
                - GA
                - GM
                - GE
                - DE
                - GH
                - GI
                - GR
                - GL
                - GD
                - GP
                - GU
                - GT
                - GG
                - GN
                - GW
                - GY
                - HT
                - HM
                - VA
                - HN
                - HK
                - HU
                - IS
                - IN
                - ID
                - IR
                - IQ
                - IE
                - IM
                - IL
                - IT
                - JM
                - JP
                - JE
                - JO
                - KZ
                - KE
                - KI
                - KP
                - KR
                - KW
                - KG
                - LA
                - LV
                - LB
                - LS
                - LR
                - LY
                - LI
                - LT
                - LU
                - MO
                - MG
                - MW
                - MY
                - MV
                - ML
                - MT
                - MH
                - MQ
                - MR
                - MU
                - YT
                - MX
                - FM
                - MD
                - MC
                - MN
                - ME
                - MS
                - MA
                - MZ
                - MM
                - NA
                - NR
                - NP
                - NL
                - NC
                - NZ
                - NI
                - NE
                - NG
                - NU
                - NF
                - MK
                - MP
                - 'NO'
                - OM
                - PK
                - PW
                - PS
                - PA
                - PG
                - PY
                - PE
                - PH
                - PN
                - PL
                - PT
                - PR
                - QA
                - RE
                - RO
                - RU
                - RW
                - BL
                - SH
                - KN
                - LC
                - MF
                - PM
                - VC
                - WS
                - SM
                - ST
                - SA
                - SN
                - RS
                - SC
                - SL
                - SG
                - SX
                - SK
                - SI
                - SB
                - SO
                - ZA
                - GS
                - SS
                - ES
                - LK
                - SD
                - SR
                - SJ
                - SE
                - CH
                - SY
                - TW
                - TJ
                - TZ
                - TH
                - TL
                - TG
                - TK
                - TO
                - TT
                - TN
                - TR
                - TM
                - TC
                - TV
                - UG
                - UA
                - AE
                - GB
                - US
                - UM
                - UY
                - UZ
                - VU
                - VE
                - VN
                - VG
                - VI
                - WF
                - EH
                - YE
                - ZM
                - ZW
              description: Country (ISO 3166-1 alpha-2)
              example: US
          required:
            - addressLine1
            - city
            - country
          description: >-
            Registered office address. Same nested shape the onboarding request
            submits, so it round-trips field-for-field.
        dateOfIncorporation:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Date the business was incorporated (YYYY-MM-DD)
          example: '2020-03-15'
        website:
          description: Business website URL
          example: https://acmepay.com
          type: string
        legalStructure:
          type: string
          description: >-
            Legal structure of the business — the local jurisdiction name the
            customer declared at onboarding (e.g. 'Sociedade Limitada', 'GmbH',
            'C-Corporation'). Free-form string; the available options are
            jurisdiction-specific and surfaced by the requirements discovery
            endpoint.
          example: Sociedade Limitada
        coreIndustry:
          description: Primary industry classification of the business
          example: Financial Technology
          type: string
          enum:
            - Agriculture
            - Mining
            - Manufacturing
            - Retail/Wholesale
            - Healthcare
            - Real Estate
            - Transport/Logistics
            - Energy
            - Education
            - Financial Technology
            - Professional Services
            - Hospitality
            - Construction
            - Telecommunications
            - Other
        primaryIndustry:
          description: >-
            Attested primary industry. The accepted values change over time, so
            read the current set from `GET
            /v2/onboarding/policy-subjects?axis=industry`.
          example: fintech_companies
          type: string
        primaryIndustryLabel:
          description: >-
            Display name of the attested primary industry, as it appears in the
            current policy catalog. Omitted when the business attested no
            industry, or when the key has no catalog row.
          example: Fintech Companies
          type: string
        regulatedOrRestrictedActivities:
          description: >-
            Attested regulated or restricted activities. The accepted values
            change over time, so read the current set from `GET
            /v2/onboarding/policy-subjects?axis=regulated_activity`.
          type: array
          items:
            type: string
        contactEmail:
          type: string
          description: Primary business contact email
          example: compliance@acmepay.com
        contactPhone:
          description: Primary business contact phone number
          example: '+14155551234'
          type: string
      required:
        - id
        - applicationId
        - createdAt
        - updatedAt
        - features
        - isHouseAccount
        - type
        - legalName
        - taxId
        - registeredAddress
        - dateOfIncorporation
        - legalStructure
        - contactEmail
    IndividualCustomerResponseDto:
      type: object
      properties:
        id:
          type: string
          pattern: ^cus_[0-9A-Za-z]{22}$
          description: Unique customer identifier
        clientReferenceId:
          description: >-
            Client-provided external identifier for cross-referencing. 1-255
            characters from A-Za-z, 0-9, underscore, hyphen, colon, and period —
            no spaces.
          example: client-cus-001
          type: string
          pattern: ^[A-Za-z0-9_\-:.]{1,255}$
        applicationId:
          type: string
          pattern: ^app_[0-9A-Za-z]{22}$
          description: ID of the onboarding application that created this customer.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the customer was created
          example: '2026-01-15T09:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the customer was last modified
          example: '2026-01-15T09:30:00.000Z'
        features:
          type: array
          items:
            type: object
            properties:
              feature:
                description: Feature identifier
                type: string
                enum:
                  - virtual_account
                  - crypto_wallet
              isActive:
                type: boolean
                description: Whether this feature is currently active for the customer
                example: true
            required:
              - feature
              - isActive
          description: List of features enabled for this customer
        isHouseAccount:
          type: boolean
          description: >-
            Whether this customer is the organization's own house account rather
            than an external customer. Read-only on live; on sandbox, set it
            with `PATCH /v2/sandbox/customers/{customerId}/house-account`.
          example: false
        signingMode:
          description: >-
            Effective signing mode for this customer right now: the per-customer
            override if one exists, else the organization setting, else the
            default. For a customer with no wallet claim yet, this is the value
            `claim-non-custodial` would freeze and the roster shape it accepts.
            For a customer that already claimed, the claimed wallet keeps the
            mode it froze at claim time, even if this value changes afterward.
            This field may be absent temporarily while the API is being updated.
          type: string
          enum:
            - passkey_required
            - programmatic
            - programmatic_unattended
        type:
          type: string
          enum:
            - individual
        individualId:
          type: string
          pattern: ^ind_[0-9A-Za-z]{22}$
          description: >-
            ID of the account holder's identity record. Send it as
            `ownership.persons[0].id` to edit the account holder through POST
            /customers/{customerId}/updates.
        firstName:
          type: string
          description: Individual's first name
          example: Jane
        lastName:
          type: string
          description: Individual's last name
          example: Doe
        middleName:
          description: Individual's middle name. Omitted if not provided.
          example: Marie
          type: string
        email:
          type: string
          description: Individual's email address
          example: jane.doe@example.com
        phone:
          description: >-
            Individual's phone number as submitted at onboarding: E.164, or a
            national number that the address country completes
          example: '+14155559876'
          type: string
        birthDate:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Date of birth (YYYY-MM-DD)
          example: '1990-05-20'
        nationality:
          type: string
          enum:
            - AF
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - CV
            - KH
            - CM
            - CA
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - SZ
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MK
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - GB
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
          description: Country of nationality (ISO 3166-1 alpha-2)
          example: US
        taxIdType:
          description: >-
            The person's tax identification type (SSN or ITIN for US persons,
            national tax ID otherwise). Omitted for non-US persons who owe no
            tax ID.
          example: SSN
          type: string
          enum:
            - PASSPORT
            - NATIONAL_ID
            - DRIVER_LICENSE
            - RESIDENT_CARD
            - SSN
            - ITIN
        taxIdCountry:
          description: >-
            Country whose tax authority issued the tax ID (ISO 3166-1 alpha-2).
            Omitted for non-US persons who owe no tax ID.
          example: US
          type: string
          enum:
            - AF
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - CV
            - KH
            - CM
            - CA
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - SZ
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MK
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - GB
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        taxResidencyCountry:
          description: >-
            Country of tax residency (ISO 3166-1 alpha-2). Omitted if not
            provided.
          example: US
          type: string
          enum:
            - AF
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - CV
            - KH
            - CM
            - CA
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - SZ
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MK
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - GB
            - US
            - UM
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - YE
            - ZM
            - ZW
        address:
          description: >-
            Residential address. Same nested shape the onboarding request
            submits under `ownership.persons[0].address`. Omitted when the
            person submitted none.
          type: object
          properties:
            addressLine1:
              type: string
              description: Primary street address
              example: 100 Market St
            addressLine2:
              description: Secondary address line (suite, floor, etc.)
              example: Suite 400
              type: string
            city:
              type: string
              description: City
              example: San Francisco
            state:
              description: State or province
              example: CA
              type: string
            postalCode:
              description: Postal code
              example: '94105'
              type: string
            country:
              type: string
              enum:
                - AF
                - AL
                - DZ
                - AS
                - AD
                - AO
                - AI
                - AQ
                - AG
                - AR
                - AM
                - AW
                - AU
                - AT
                - AZ
                - BS
                - BH
                - BD
                - BB
                - BY
                - BE
                - BZ
                - BJ
                - BM
                - BT
                - BO
                - BQ
                - BA
                - BW
                - BV
                - BR
                - IO
                - BN
                - BG
                - BF
                - BI
                - CV
                - KH
                - CM
                - CA
                - KY
                - CF
                - TD
                - CL
                - CN
                - CX
                - CC
                - CO
                - KM
                - CG
                - CD
                - CK
                - CR
                - CI
                - HR
                - CU
                - CW
                - CY
                - CZ
                - DK
                - DJ
                - DM
                - DO
                - EC
                - EG
                - SV
                - GQ
                - ER
                - EE
                - SZ
                - ET
                - FK
                - FO
                - FJ
                - FI
                - FR
                - GF
                - PF
                - TF
                - GA
                - GM
                - GE
                - DE
                - GH
                - GI
                - GR
                - GL
                - GD
                - GP
                - GU
                - GT
                - GG
                - GN
                - GW
                - GY
                - HT
                - HM
                - VA
                - HN
                - HK
                - HU
                - IS
                - IN
                - ID
                - IR
                - IQ
                - IE
                - IM
                - IL
                - IT
                - JM
                - JP
                - JE
                - JO
                - KZ
                - KE
                - KI
                - KP
                - KR
                - KW
                - KG
                - LA
                - LV
                - LB
                - LS
                - LR
                - LY
                - LI
                - LT
                - LU
                - MO
                - MG
                - MW
                - MY
                - MV
                - ML
                - MT
                - MH
                - MQ
                - MR
                - MU
                - YT
                - MX
                - FM
                - MD
                - MC
                - MN
                - ME
                - MS
                - MA
                - MZ
                - MM
                - NA
                - NR
                - NP
                - NL
                - NC
                - NZ
                - NI
                - NE
                - NG
                - NU
                - NF
                - MK
                - MP
                - 'NO'
                - OM
                - PK
                - PW
                - PS
                - PA
                - PG
                - PY
                - PE
                - PH
                - PN
                - PL
                - PT
                - PR
                - QA
                - RE
                - RO
                - RU
                - RW
                - BL
                - SH
                - KN
                - LC
                - MF
                - PM
                - VC
                - WS
                - SM
                - ST
                - SA
                - SN
                - RS
                - SC
                - SL
                - SG
                - SX
                - SK
                - SI
                - SB
                - SO
                - ZA
                - GS
                - SS
                - ES
                - LK
                - SD
                - SR
                - SJ
                - SE
                - CH
                - SY
                - TW
                - TJ
                - TZ
                - TH
                - TL
                - TG
                - TK
                - TO
                - TT
                - TN
                - TR
                - TM
                - TC
                - TV
                - UG
                - UA
                - AE
                - GB
                - US
                - UM
                - UY
                - UZ
                - VU
                - VE
                - VN
                - VG
                - VI
                - WF
                - EH
                - YE
                - ZM
                - ZW
              description: Country (ISO 3166-1 alpha-2)
              example: US
          required:
            - addressLine1
            - city
            - country
        activity:
          type: object
          properties:
            occupation:
              example: Teacher
              type: string
            employerName:
              example: Acme School
              type: string
            accountPurpose:
              type: array
              items:
                type: string
                enum:
                  - Receive Salary
                  - Savings
                  - Family Support
                  - Pay Bills
                  - Investment
                  - Business Payments
                  - Treasury Management
                  - Payroll
                  - Vendor/Supplier Payments
                  - Operating Expenses
                  - Client Collections
                  - FX Settlement
                  - Escrow
                  - Other
            sourceOfFunds:
              type: array
              items:
                type: string
                enum:
                  - Salary
                  - Business Income
                  - Savings
                  - Investment
                  - Inheritance
                  - Gift
                  - Sale of Asset
                  - Other
                  - Revenue/Sales
                  - VC/PE Investment
                  - Loans/Debt Financing
                  - Government Grant
                  - Personal/Founder Funds
                  - Donations
            sourceOfWealth:
              type: array
              items:
                type: string
                enum:
                  - Salary
                  - Business Income
                  - Savings
                  - Investment
                  - Inheritance
                  - Gift
                  - Sale of Asset
                  - Other
            expectedMonthlyVolume:
              type: string
              enum:
                - VOLUME_LT_10K
                - VOLUME_10K_50K
                - VOLUME_50K_250K
                - VOLUME_250K_1M
                - VOLUME_GT_1M
            expectedTransactionsPerMonth:
              type: string
              enum:
                - <10
                - 10-50
                - 50-200
                - 200-1,000
                - 1,000+
            countriesOfActivity:
              type: array
              items:
                type: string
                enum:
                  - AFG
                  - ALB
                  - DZA
                  - ASM
                  - AND
                  - AGO
                  - AIA
                  - ATA
                  - ATG
                  - ARG
                  - ARM
                  - ABW
                  - AUS
                  - AUT
                  - AZE
                  - BHS
                  - BHR
                  - BGD
                  - BRB
                  - BLR
                  - BEL
                  - BLZ
                  - BEN
                  - BMU
                  - BTN
                  - BOL
                  - BES
                  - BIH
                  - BWA
                  - BVT
                  - BRA
                  - IOT
                  - BRN
                  - BGR
                  - BFA
                  - BDI
                  - CPV
                  - KHM
                  - CMR
                  - CAN
                  - CYM
                  - CAF
                  - TCD
                  - CHL
                  - CHN
                  - CXR
                  - CCK
                  - COL
                  - COM
                  - COG
                  - COD
                  - COK
                  - CRI
                  - CIV
                  - HRV
                  - CUB
                  - CUW
                  - CYP
                  - CZE
                  - DNK
                  - DJI
                  - DMA
                  - DOM
                  - ECU
                  - EGY
                  - SLV
                  - GNQ
                  - ERI
                  - EST
                  - SWZ
                  - ETH
                  - FLK
                  - FRO
                  - FJI
                  - FIN
                  - FRA
                  - GUF
                  - PYF
                  - ATF
                  - GAB
                  - GMB
                  - GEO
                  - DEU
                  - GHA
                  - GIB
                  - GRC
                  - GRL
                  - GRD
                  - GLP
                  - GUM
                  - GTM
                  - GGY
                  - GIN
                  - GNB
                  - GUY
                  - HTI
                  - HMD
                  - VAT
                  - HND
                  - HKG
                  - HUN
                  - ISL
                  - IND
                  - IDN
                  - IRN
                  - IRQ
                  - IRL
                  - IMN
                  - ISR
                  - ITA
                  - JAM
                  - JPN
                  - JEY
                  - JOR
                  - KAZ
                  - KEN
                  - KIR
                  - PRK
                  - KOR
                  - KWT
                  - KGZ
                  - LAO
                  - LVA
                  - LBN
                  - LSO
                  - LBR
                  - LBY
                  - LIE
                  - LTU
                  - LUX
                  - MAC
                  - MDG
                  - MWI
                  - MYS
                  - MDV
                  - MLI
                  - MLT
                  - MHL
                  - MTQ
                  - MRT
                  - MUS
                  - MYT
                  - MEX
                  - FSM
                  - MDA
                  - MCO
                  - MNG
                  - MNE
                  - MSR
                  - MAR
                  - MOZ
                  - MMR
                  - NAM
                  - NRU
                  - NPL
                  - NLD
                  - NCL
                  - NZL
                  - NIC
                  - NER
                  - NGA
                  - NIU
                  - NFK
                  - MKD
                  - MNP
                  - NOR
                  - OMN
                  - PAK
                  - PLW
                  - PSE
                  - PAN
                  - PNG
                  - PRY
                  - PER
                  - PHL
                  - PCN
                  - POL
                  - PRT
                  - PRI
                  - QAT
                  - REU
                  - ROU
                  - RUS
                  - RWA
                  - BLM
                  - SHN
                  - KNA
                  - LCA
                  - MAF
                  - SPM
                  - VCT
                  - WSM
                  - SMR
                  - STP
                  - SAU
                  - SEN
                  - SRB
                  - SYC
                  - SLE
                  - SGP
                  - SXM
                  - SVK
                  - SVN
                  - SLB
                  - SOM
                  - ZAF
                  - SGS
                  - SSD
                  - ESP
                  - LKA
                  - SDN
                  - SUR
                  - SJM
                  - SWE
                  - CHE
                  - SYR
                  - TWN
                  - TJK
                  - TZA
                  - THA
                  - TLS
                  - TGO
                  - TKL
                  - TON
                  - TTO
                  - TUN
                  - TUR
                  - TKM
                  - TCA
                  - TUV
                  - UGA
                  - UKR
                  - ARE
                  - GBR
                  - USA
                  - UMI
                  - URY
                  - UZB
                  - VUT
                  - VEN
                  - VNM
                  - VGB
                  - VIR
                  - WLF
                  - ESH
                  - YEM
                  - ZMB
                  - ZWE
          description: >-
            The account holder's activity answers, with the keys and values the
            onboarding request submits under `activity`. Omitted when none are
            on file.
        regulatoryHistory:
          description: >-
            The account holder's politically-exposed-person answer, under the
            key the onboarding request submits. Omitted when none is on file.
          type: object
          properties:
            isPoliticallyExposedPerson:
              type: boolean
          required:
            - isPoliticallyExposedPerson
      required:
        - id
        - applicationId
        - createdAt
        - updatedAt
        - features
        - isHouseAccount
        - type
        - individualId
        - firstName
        - lastName
        - email
        - birthDate
        - nationality
    ValidationErrorDto:
      type: object
      properties:
        type:
          type: string
          description: Machine-readable error code
          example: CUSTOMER_NOT_FOUND
        title:
          type: string
          description: Human-readable error type label
          example: Customer Not Found
        status:
          type: number
          description: HTTP status code
          example: 404
        detail:
          type: string
          description: Human-readable explanation of this occurrence
          example: Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found
        resolution:
          type: string
          description: What the developer should do to resolve this error
          example: >-
            Verify the customer ID. Check you are using the correct API key for
            this organization.
        docs:
          type: string
          description: URL to error documentation
          example: https://conduit-v2.mintlify.app/errors#customer-not-found
        instance:
          type: string
          description: Request path that produced the error
          example: /v2/customers/cus_034A0gCCVsxdV2PjHLx9k1
        correlationId:
          description: Request correlation ID
          example: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
          type: string
        timestamp:
          type: string
          description: ISO 8601 UTC timestamp
          example: '2026-04-27T20:00:00.000Z'
        details:
          description: >-
            Additional structured data for domain-specific errors (e.g. missing
            field lists, pair info)
        errors:
          type: array
          items:
            type: object
            properties:
              pointer:
                type: string
                description: JSON pointer to the invalid field
                example: /email
              detail:
                type: string
                description: What is wrong with this field
                example: Invalid email format
              allowedValues:
                description: The values this field accepts, when it is a closed set
                example:
                  - ach
                  - fedwire
                  - rtp
                type: array
                items:
                  type: string
              category:
                description: >-
                  Class of blocker (requirements-validator output only). 'field'
                  = form-field gap, 'document' = missing or insufficient
                  document (including per-UBO document slots), 'individual' =
                  required person missing.
                example: field
                type: string
                enum:
                  - field
                  - document
                  - individual
            required:
              - pointer
              - detail
      required:
        - type
        - title
        - status
        - detail
        - resolution
        - docs
        - instance
        - timestamp
    ProblemDetailDto:
      type: object
      properties:
        type:
          type: string
          description: Machine-readable error code
          example: CUSTOMER_NOT_FOUND
        title:
          type: string
          description: Human-readable error type label
          example: Customer Not Found
        status:
          type: number
          description: HTTP status code
          example: 404
        detail:
          type: string
          description: Human-readable explanation of this occurrence
          example: Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found
        resolution:
          type: string
          description: What the developer should do to resolve this error
          example: >-
            Verify the customer ID. Check you are using the correct API key for
            this organization.
        docs:
          type: string
          description: URL to error documentation
          example: https://conduit-v2.mintlify.app/errors#customer-not-found
        instance:
          type: string
          description: Request path that produced the error
          example: /v2/customers/cus_034A0gCCVsxdV2PjHLx9k1
        correlationId:
          description: Request correlation ID
          example: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
          type: string
        timestamp:
          type: string
          description: ISO 8601 UTC timestamp
          example: '2026-04-27T20:00:00.000Z'
        details:
          description: >-
            Additional structured data for domain-specific errors (e.g. missing
            field lists, pair info)
      required:
        - type
        - title
        - status
        - detail
        - resolution
        - docs
        - instance
        - timestamp
    RateLimitedErrorDto:
      type: object
      properties:
        type:
          type: string
          description: Machine-readable error code
          example: CUSTOMER_NOT_FOUND
        title:
          type: string
          description: Human-readable error type label
          example: Customer Not Found
        status:
          type: number
          description: HTTP status code
          example: 404
        detail:
          type: string
          description: Human-readable explanation of this occurrence
          example: Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found
        resolution:
          type: string
          description: What the developer should do to resolve this error
          example: >-
            Verify the customer ID. Check you are using the correct API key for
            this organization.
        docs:
          type: string
          description: URL to error documentation
          example: https://conduit-v2.mintlify.app/errors#customer-not-found
        instance:
          type: string
          description: Request path that produced the error
          example: /v2/customers/cus_034A0gCCVsxdV2PjHLx9k1
        correlationId:
          description: Request correlation ID
          example: 00469ea4-52c1-4ffa-bd05-9f28b236a5fe
          type: string
        timestamp:
          type: string
          description: ISO 8601 UTC timestamp
          example: '2026-04-27T20:00:00.000Z'
        details:
          description: >-
            Additional structured data for domain-specific errors (e.g. missing
            field lists, pair info)
        retryAfterSeconds:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
          description: Seconds to wait before retrying
          example: 3
      required:
        - type
        - title
        - status
        - detail
        - resolution
        - docs
        - instance
        - timestamp
        - retryAfterSeconds
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.