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

# List Child orgs

> Your Child orgs, newest first.



## OpenAPI

````yaml /v2/openapi.json get /child-orgs
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:
  /child-orgs:
    get:
      summary: List Child orgs
      description: Your Child orgs, newest first.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            description: Page size, 1-200 (default 50).
          required: false
          description: Page size, 1-200 (default 50).
          name: limit
          in: query
        - schema:
            type: string
            format: uuid
            description: 'Keyset cursor: the `next_before_id` from the previous page.'
          required: false
          description: 'Keyset cursor: the `next_before_id` from the previous page.'
          name: before_id
          in: query
        - $ref: '#/components/parameters/HermesOrg'
      responses:
        '200':
          description: One page of your Child orgs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChildOrgList'
        '400':
          description: '`limit` or `before_id` is not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '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:
    ChildOrgList:
      type: object
      properties:
        child_orgs:
          type: array
          items:
            $ref: '#/components/schemas/ChildOrg'
        has_more:
          type: boolean
        next_before_id:
          type:
            - string
            - 'null'
          format: uuid
      required:
        - child_orgs
        - has_more
        - next_before_id
    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
    ChildOrg:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The Child org id.
        type:
          type: string
          enum:
            - individual
            - business
        display_name:
          type: string
        reference:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - incomplete
            - in_review
            - action_required
            - active
            - rejected
            - suspended
          description: >-
            `incomplete`: `requirements` lists what you still owe before review.
            `in_review`: nothing is owed; the review is in progress.
            `action_required`: the review needs more from you; `requirements`
            lists it, and you send it with `POST
            /v2/child-orgs/{id}/information`. `active`: approved; the Child org
            can transact. `requirements` can list a request after approval; the
            status stays `active`. `rejected`: final; to try again, create a new
            Child org. `suspended`: the Child org or your organization is
            suspended.
        requirements:
          type: array
          items:
            $ref: '#/components/schemas/ChildOrgRequirement'
        capabilities:
          type: object
          properties:
            usd_collections:
              type: string
              enum:
                - pending
                - active
                - unavailable
            usd_payouts:
              type: string
              enum:
                - pending
                - active
                - unavailable
          required:
            - usd_collections
            - usd_payouts
        associated_parties:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
            required:
              - id
          description: >-
            A business’s associated parties, in the order you sent them. Name a
            party’s `id` when you upload its documents.
        terms_url:
          type:
            - string
            - 'null'
          description: >-
            The terms page to show your customer. After your customer accepts,
            send `terms_value`. Null after you send it.
        created_at:
          type: string
          format: date-time
      required:
        - id
        - type
        - display_name
        - reference
        - status
        - requirements
        - capabilities
        - associated_parties
        - terms_url
        - created_at
    ChildOrgRequirement:
      type: object
      properties:
        party_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The associated party that owes it; null for the Child org itself.
        field:
          type:
            - string
            - 'null'
          description: >-
            A detail that is owed, e.g. `terms_value` or
            `identity_document.expiry_date`. Null for a document.
          example: terms_value
        document_category:
          type:
            - string
            - 'null'
          description: The category of document that is owed. Null for a detail.
          example: identifying_documents
        document_types:
          type: array
          items:
            type: string
          description: 'The document `type`s that satisfy it: one of them is enough.'
          example:
            - passport
            - national_id
        reason:
          type: string
          enum:
            - missing
            - expired
            - invalid
      required:
        - party_id
        - field
        - document_category
        - document_types
        - reason
  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.