> ## 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 designated services

> The catalog of designated-service codes accepted by the
`designatedServices` field on `POST /customers` — discover valid
codes programmatically instead of hardcoding the table from the
`DesignatedServices` schema docs.

The catalog is static application data derived from the AML/CTF
Act's designated-services tables: it is the same for every
organisation, changes only with legislation, and needs no
pagination. In addition to these codes, `designatedServices` also
accepts custom services encoded as
`OTHER__<LOW|MEDIUM|HIGH>__<label>` — for a service not in the
catalog, with the risk tier of your choosing.

Requires the `customers:read` scope.


The catalog of designated services, grouped by category. Each entry
carries the stable `code` you pass in `designatedServices` on the
customer and entity endpoints, plus a human label and description.

Codes are stable identifiers — cache them freely, but fetch this list
when building a picker so newly enabled services appear without a code
change on your side.

Unknown or non-designated codes sent to any write endpoint are rejected
with `422 validation_failed` — nothing is silently dropped, so a typo
surfaces immediately instead of producing a thinner service set.


## OpenAPI

````yaml GET /designated-services
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:
  /designated-services:
    get:
      tags:
        - Designated services
      summary: List the designated-service catalog
      description: |
        The catalog of designated-service codes accepted by the
        `designatedServices` field on `POST /customers` — discover valid
        codes programmatically instead of hardcoding the table from the
        `DesignatedServices` schema docs.

        The catalog is static application data derived from the AML/CTF
        Act's designated-services tables: it is the same for every
        organisation, changes only with legislation, and needs no
        pagination. In addition to these codes, `designatedServices` also
        accepts custom services encoded as
        `OTHER__<LOW|MEDIUM|HIGH>__<label>` — for a service not in the
        catalog, with the risk tier of your choosing.

        Requires the `customers:read` scope.
      operationId: listDesignatedServices
      responses:
        '200':
          description: The full designated-service catalog.
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - data
                properties:
                  object:
                    type: string
                    const: list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DesignatedServiceCatalogEntry'
              example:
                object: list
                data:
                  - code: PRO-FORMATION
                    label: Company or trust formation
                    description: >-
                      Setting up new companies, trusts, partnerships, or other
                      legal entities for clients.
                    category: PROFESSIONAL
                    category_label: Professional Services
                  - code: RE-BROKER
                    label: Real estate agency (brokering sales)
                    description: >-
                      Brokering the sale, purchase, or transfer of real estate
                      for a client — i.e. acting as a real-estate agent
                      (including buyer's and seller's agents).
                    category: REAL_ESTATE
                    category_label: Real Estate
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: curl
          source: |
            curl https://app.instantcompliance.ai/api/v1/designated-services \
              -H "Authorization: Bearer ic_live_..."
components:
  schemas:
    DesignatedServiceCatalogEntry:
      type: object
      required:
        - code
        - label
        - description
        - category
        - category_label
      properties:
        code:
          type: string
          description: Stable code to pass in `designatedServices`.
          example: PRO-FORMATION
        label:
          type: string
          example: Company or trust formation
        description:
          type: string
          example: >-
            Setting up new companies, trusts, partnerships, or other legal
            entities for clients.
        category:
          type: string
          enum:
            - PROFESSIONAL
            - REAL_ESTATE
            - FINANCIAL
            - OTHER_DESIGNATED
          example: PROFESSIONAL
        category_label:
          type: string
          example: Professional Services
    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
    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_…`.

````