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

# Get an entity's AML status

> AML compliance sub-resource. Returns only the AML status and
category flags — useful for reporting-only integrations that hold
the narrower `aml:read` scope instead of `customers:read`.


AML compliance sub-resource for entity customers. Returns only the AML
status and category flags — useful for reporting-only integrations
that hold the narrower `aml:read` scope instead of `customers:read`.

The block is identical in shape to the individual customer
[AML sub-resource](/api-reference/customers/aml); for entities it
reflects the business-level screening (sanctions, adverse media) run
during KYB.


## OpenAPI

````yaml GET /entities/{id}/aml
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}/aml:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: |
          Entity identifier. Accepts either Instant Compliance's UUID
          (`550e8400-…`) or your own `external_id` — the format is
          detected automatically.
    get:
      tags:
        - Entities
      summary: Get an entity's AML status
      description: |
        AML compliance sub-resource. Returns only the AML status and
        category flags — useful for reporting-only integrations that hold
        the narrower `aml:read` scope instead of `customers:read`.
      operationId: getEntityAml
      responses:
        '200':
          description: AML status block.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlBlock'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
components:
  schemas:
    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
    AmlStatus:
      type: string
      enum:
        - NOT_SCREENED
        - IN_PROGRESS
        - CLEAR
        - NEEDS_REVIEW
        - RESOLVED
    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
    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_…`.

````