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

# List beneficial owners

> Individual beneficial owners of the entity, with their verification
state. Only individuals are returned (the people who get verified) — the
raw ownership-tree structure and any owner's link token are never
exposed. Requires `customers:read`.


The entity's **individual** beneficial owners and their verification state — the
people who get verified. The raw ownership-tree structure (intermediate
companies, share classes) and each owner's live link token are never exposed;
this is the deliberate, minimal extension of the entity DTO's "no UBO chains"
boundary. Requires the `customers:read` scope.


## OpenAPI

````yaml GET /entities/{id}/ubos
openapi: 3.1.0
info:
  title: Instant Compliance API
  version: 1.0.0
  summary: External integration API for Instant Compliance.
  description: |
    The Instant Compliance v1 API lets your systems push customers into
    Instant Compliance and pull their verification / AML status back out.
    Designed for server-to-server use (CRMs, Zapier, internal back-office
    tools).

    **Base URL:** `https://app.instantcompliance.ai/api/v1`

    **Authentication:** Bearer API key — `Authorization: Bearer ic_live_…`
    Issue keys from **Settings → Developers** in your Instant Compliance
    organisation.

    **Scope:** individual customers (`INDIVIDUAL` and `SOLE_TRADER`, KYC)
    live on `/customers`; entity customers (companies, trusts,
    partnerships, SMSFs — KYB) live on `/entities`.
  contact:
    name: Instant Compliance Support
    email: support@instantcompliance.ai
    url: https://instantcompliance.ai
  license:
    name: Proprietary
servers:
  - url: https://app.instantcompliance.ai/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: |
      Create, read, and update individual customer records ingested through
      the external API.
  - name: Entities
    description: |
      Create, read, and update entity customer records (companies, trusts,
      partnerships, SMSFs). Entities verify via KYB instead of KYC; the API
      ingests the record and reports status — verification is started by
      your back-office team in-app.
  - name: Designated services
    description: |
      Read-only catalog of the designated-service codes accepted when
      creating customers.
  - name: Groups
    description: |
      Create group workspaces (multi-party deals/matters — e.g. one per
      property for real-estate integrators) and discover the group
      templates available to your organisation. Requires the Groups
      feature to be enabled for your organisation.
paths:
  /entities/{id}/ubos:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: |
          Entity identifier. Accepts either Instant Compliance's UUID or your
          own `external_id`.
    get:
      tags:
        - Entities
      summary: List an entity's beneficial owners
      description: |
        Individual beneficial owners of the entity, with their verification
        state. Only individuals are returned (the people who get verified) — the
        raw ownership-tree structure and any owner's link token are never
        exposed. Requires `customers:read`.
      operationId: listEntityUbos
      responses:
        '200':
          description: The entity's individual beneficial owners.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UboList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
components:
  schemas:
    UboList:
      type: object
      properties:
        ubos:
          type: array
          items:
            $ref: '#/components/schemas/Ubo'
    Ubo:
      type: object
      description: >-
        A beneficial owner. Never includes link tokens, applicant ids, or
        payment fields.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        holder_type:
          type: string
        role_type:
          oneOf:
            - $ref: '#/components/schemas/UboRoleType'
            - type: 'null'
        role_types:
          type: array
          items:
            $ref: '#/components/schemas/UboRoleType'
        percentage_held:
          type: number
          nullable: true
        kyc_required:
          type: boolean
          description: False for excluded / recorded-only parties that are never checked.
        kyc_status:
          $ref: '#/components/schemas/KycStatus'
        kyc_email:
          type: string
          nullable: true
        linked_customer:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            external_id:
              type: string
              nullable: true
        added_via:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden_scope
                - not_found
                - validation_failed
                - conflict
                - insufficient_credits
                - rate_limited
                - idempotency_conflict
                - feature_disabled
                - internal
            message:
              type: string
            details:
              type: object
              additionalProperties: true
    UboRoleType:
      type: string
      description: Typed trust-party / ownership role.
      enum:
        - TRUSTEE
        - CORPORATE_TRUSTEE
        - SETTLOR
        - APPOINTOR
        - GUARDIAN
        - PROTECTOR
        - BENEFICIARY_NAMED
        - BENEFICIARY_CLASS
        - BENEFICIARY_EXCLUDED
        - UNIT_HOLDER
        - MEMBER
        - DIRECTOR
        - SHAREHOLDER
        - OTHER_CONTROLLER
        - OTHER
    KycStatus:
      type: string
      enum:
        - NOT_STARTED
        - PENDING
        - IN_PROGRESS
        - VERIFIED
        - FAILED
        - NOT_REQUIRED
        - AWAITING_RESUBMISSION
  responses:
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Invalid or revoked API key.
    ForbiddenScope:
      description: API key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden_scope
              message: This API key does not have the required scope. customers:write
              details:
                required_scope: customers:write
    NotFound:
      description: No customer matching the supplied id in this organisation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Customer not found.
    RateLimited:
      description: Burst or daily rate limit exceeded for this API key.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded. Slow down and retry shortly.
              details:
                limit: 60
                window_seconds: 60
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        Bearer API key issued from **Settings → Developers** in your
        Instant Compliance organisation. Format: `ic_live_…`.

````