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

> List entity customers in your organisation. Use this as a polling
source — pass `updated_since` so each poll only returns records
that changed since the previous run.

Pagination is cursor-based: pass the `next_cursor` value from the
previous response as `cursor` on the next call.


List the entity customers (companies, trusts, partnerships, SMSFs) in
your organisation. Works exactly like
[`GET /customers`](/api-reference/customers/list) — cursor pagination,
`updated_since` polling, opt-in `total_count` — with two differences:

* `status` filters on the entity's **KYB** status (`kyb_status`), since
  entities verify via KYB rather than KYC.
* `type` filters by entity type (`COMPANY`, `TRUST`, `PARTNERSHIP`,
  `SMSF`, `OTHER`).

See [Pagination](/concepts/pagination) and
[Polling for status changes](/guides/polling-status).


## OpenAPI

````yaml GET /entities
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:
    get:
      tags:
        - Entities
      summary: List entities
      description: |
        List entity customers in your organisation. Use this as a polling
        source — pass `updated_since` so each poll only returns records
        that changed since the previous run.

        Pagination is cursor-based: pass the `next_cursor` value from the
        previous response as `cursor` on the next call.
      operationId: listEntities
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Number of records to return (1–100).
        - in: query
          name: cursor
          schema:
            type: string
          description: Opaque cursor from the previous response's `next_cursor`.
        - in: query
          name: status
          schema:
            $ref: '#/components/schemas/KycStatus'
          description: Filter by KYB status (entities verify via KYB).
        - in: query
          name: aml_status
          schema:
            $ref: '#/components/schemas/AmlStatus'
          description: Filter by AML compliance status.
        - in: query
          name: type
          schema:
            $ref: '#/components/schemas/EntityType'
          description: Filter by entity type.
        - in: query
          name: updated_since
          schema:
            type: string
            format: date-time
          description: ISO-8601 timestamp. Return only entities updated after this time.
        - in: query
          name: external_id
          schema:
            type: string
          description: Lookup by your CRM identifier.
        - in: query
          name: include
          schema:
            type: string
            enum:
              - total_count
          description: |
            Comma-separated list of opt-in response fields. Currently the
            only supported value is `total_count`, which adds an exact
            count of the **filtered** set to the response envelope. Costs
            an extra `COUNT(*)` query — omit it on hot polling loops.
      responses:
        '200':
          description: Paginated entity list.
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - data
                  - has_more
                  - next_cursor
                  - limit
                properties:
                  object:
                    type: string
                    enum:
                      - list
                    description: Always `"list"` for paginated envelopes.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Entity'
                  has_more:
                    type: boolean
                    description: >-
                      True if at least one more page exists. Use as the loop
                      condition.
                  next_cursor:
                    type: string
                    nullable: true
                    description: >-
                      Pass as `cursor` on the next request, or `null` when no
                      more pages.
                  limit:
                    type: integer
                    description: >-
                      The limit echoed back after defaulting/clamping (1–100,
                      default 50).
                  total_count:
                    type: integer
                    description: >
                      Total records matching the filter set (not the page). Only
                      present

                      when the request included `include=total_count`.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    KycStatus:
      type: string
      enum:
        - NOT_STARTED
        - PENDING
        - IN_PROGRESS
        - VERIFIED
        - FAILED
        - NOT_REQUIRED
        - AWAITING_RESUBMISSION
    AmlStatus:
      type: string
      enum:
        - NOT_SCREENED
        - IN_PROGRESS
        - CLEAR
        - NEEDS_REVIEW
        - RESOLVED
    EntityType:
      type: string
      enum:
        - COMPANY
        - TRUST
        - PARTNERSHIP
        - SMSF
        - OTHER
      description: |
        Entity customer types accepted by `/entities`. `SMSF` is treated
        as a type of trust and `OTHER` as a company for verification
        purposes, but the type you post round-trips back unchanged.
        Immutable after creation.
    Entity:
      type: object
      required:
        - id
        - type
        - name
        - origin
        - kyb_status
        - aml
        - added_via
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Instant Compliance customer UUID (entities are customers too).
        external_id:
          type: string
          nullable: true
        type:
          $ref: '#/components/schemas/EntityType'
        name:
          type: string
          description: The entity's legal name.
        origin:
          $ref: '#/components/schemas/EntityOrigin'
        abn:
          type: string
          nullable: true
        acn:
          type: string
          nullable: true
        country_of_formation:
          type: string
          nullable: true
          description: |
            ISO 3166-1 alpha-3. `AUS` for Australian entities; the country
            of formation for international entities.
        registration_number:
          type: string
          nullable: true
          description: Registry number recorded for international entities.
        kyb_status:
          $ref: '#/components/schemas/KycStatus'
        kyb_started_at:
          type: string
          format: date-time
          nullable: true
        kyb_completed_at:
          type: string
          format: date-time
          nullable: true
        contact:
          $ref: '#/components/schemas/EntityContact'
        aml:
          $ref: '#/components/schemas/AmlBlock'
        added_via:
          $ref: '#/components/schemas/AddedVia'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      example:
        id: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        external_id: crm-ent-311
        type: COMPANY
        name: Acme Holdings Pty Ltd
        origin: AUSTRALIAN
        abn: '12345678901'
        acn: '123456789'
        country_of_formation: AUS
        registration_number: null
        kyb_status: IN_PROGRESS
        kyb_started_at: '2026-06-23T01:00:00Z'
        kyb_completed_at: null
        contact:
          id: 550e8400-e29b-41d4-a716-446655440000
          external_id: crm-7741
          full_name: Jane Doe
          email: jane@example.com
          kyc_status: PENDING
          kyc_required: true
        aml:
          status: CLEAR
          screened_at: '2026-06-23T01:12:00Z'
          last_reviewed_at: null
          flags:
            pep: false
            sanctions: false
            adverse_media: false
            terrorism: false
        added_via: INTEGRATION
        created_at: '2026-06-22T22:14:00Z'
        updated_at: '2026-06-23T01:12:05Z'
    EntityOrigin:
      type: string
      enum:
        - AUSTRALIAN
        - INTERNATIONAL
      description: |
        Where the entity is formed. `AUSTRALIAN` (the default) uses
        ABN/ACN identifiers; `INTERNATIONAL` uses `countryOfFormation` +
        `registrationNumber`. Immutable after creation.
    EntityContact:
      type: object
      nullable: true
      required:
        - id
        - full_name
        - kyc_status
        - kyc_required
      description: The entity's current contact person, or `null` when none is set.
      properties:
        id:
          type: string
          format: uuid
        external_id:
          type: string
          nullable: true
        full_name:
          type: string
        email:
          type: string
          format: email
          nullable: true
        kyc_status:
          $ref: '#/components/schemas/KycStatus'
        kyc_required:
          type: boolean
          description: >-
            Whether the contact's own KYC is intended to run with the entity's
            KYB.
    AmlBlock:
      type: object
      required:
        - status
        - flags
      properties:
        status:
          $ref: '#/components/schemas/AmlStatus'
        screened_at:
          type: string
          format: date-time
          nullable: true
        last_reviewed_at:
          type: string
          format: date-time
          nullable: true
        flags:
          type: object
          required:
            - pep
            - sanctions
            - adverse_media
            - terrorism
          properties:
            pep:
              type: boolean
            sanctions:
              type: boolean
            adverse_media:
              type: boolean
            terrorism:
              type: boolean
    AddedVia:
      type: string
      description: How the record entered Instant Compliance.
      enum:
        - ADMIN_MANUAL
        - AI_EXTRACTED
        - CONTACT_PORTAL
        - BULK_IMPORT
        - INTEGRATION
        - SYSTEM
    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
  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
    ValidationFailed:
      description: Request payload failed schema validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: validation_failed
              message: Invalid customer payload.
              details:
                issues:
                  email:
                    - Must be a valid email address.
    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_…`.

````