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

# Get the onboarding lists

> The values that `POST /v2/child-orgs` and `POST /v2/beneficiaries` accept: occupations, purposes, sources of funds and wealth, employment statuses, entity types and party roles. Also the industry codes that Jenzy does not serve. The lists change rarely; you can keep a copy.



## OpenAPI

````yaml /v2/openapi.json get /lists
openapi: 3.1.0
info:
  title: Jenzy Hermes Multi-asset API
  version: 2.0.0
  description: >-
    Hold and pay out across the assets enabled for your organization. Every
    amount is an exact decimal string beside an `asset` field. Authenticate with
    the same `jz_live_…` API key as `/v1`.
servers:
  - url: https://api.jenzy.com/v2
    description: Production
security: []
paths:
  /lists:
    get:
      summary: Get the onboarding lists
      description: >-
        The values that `POST /v2/child-orgs` and `POST /v2/beneficiaries`
        accept: occupations, purposes, sources of funds and wealth, employment
        statuses, entity types and party roles. Also the industry codes that
        Jenzy does not serve. The lists change rarely; you can keep a copy.
      parameters:
        - $ref: '#/components/parameters/HermesOrg'
      responses:
        '200':
          description: The lists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingLists'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Organization suspended, request IP not on the allowlist, or no
            multi-asset access yet (`onboarding_incomplete` /
            `access_suspended`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: The `/v2` shutter is closed — check `GET /v2/ping`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    HermesOrg:
      name: HERMES-ORG
      in: header
      required: false
      description: >-
        The id of one of your Child orgs. The call then acts on that Child org,
        not on your organization. If you do not send it, the call acts on your
        organization. An id that is not one of your Child orgs gives `404`.
      schema:
        type: string
        format: uuid
        example: 3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10
  schemas:
    OnboardingLists:
      type: object
      properties:
        occupations:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
            required:
              - id
              - name
        employment_statuses:
          type: array
          items:
            type: string
            enum:
              - employed
              - self_employed
              - retired
              - student
              - unemployed
        entity_types:
          type: array
          items:
            type: string
            enum:
              - limited_liability_company
              - publicly_listed_company
              - sole_proprietor
              - partnership
              - corporation
              - nonprofit_organization
              - public_agency_or_authority
        party_roles:
          type: array
          items:
            type: string
            enum:
              - shareholder
              - ubo
        purposes:
          type: object
          properties:
            individual:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                required:
                  - id
                  - name
            business:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                required:
                  - id
                  - name
          required:
            - individual
            - business
        sources_of_funds:
          type: object
          properties:
            individual:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                required:
                  - id
                  - name
            business:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                required:
                  - id
                  - name
          required:
            - individual
            - business
        sources_of_wealth:
          type: object
          properties:
            business:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                required:
                  - id
                  - name
          required:
            - business
        prohibited_industry_codes:
          type: array
          items:
            type: string
          description: >-
            NAICS codes of the industries Jenzy does not serve. A Child org with
            one of them in `industry_codes` gets `422 prohibited_industry`.
      required:
        - occupations
        - employment_statuses
        - entity_types
        - party_roles
        - purposes
        - sources_of_funds
        - sources_of_wealth
        - prohibited_industry_codes
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - unknown_institution
                - invalid_mobile_number
                - invalid_account_number
                - mobile_number_institution_mismatch
                - service_unavailable
                - sandbox_only
                - insufficient_funds
                - rail_disabled
                - amount_limit_exceeded
                - org_limit_exceeded
                - service_incident
                - service_maintenance
                - onboarding_incomplete
                - access_suspended
                - corridor_not_enabled
                - unsupported_pair
                - invalid_wallet_address
                - rate_unavailable
                - quote_expired
                - quote_used
                - limit_exceeded
                - amount_below_minimum
                - unsupported_asset
                - unsupported_network
                - unsupported_media_type
                - payload_too_large
                - client_ref_used
                - beneficiary_required
                - beneficiary_not_allowed
                - proof_not_expected
                - invalid_beneficiary
                - beneficiary_exists
                - beneficiary_not_active
                - invoice_required
                - prohibited_industry
              description: >-
                Stable identifier a client may branch on — never renamed or
                removed.
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Your Jenzy API key: `Authorization: Bearer jz_live_…`'

````

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