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

# Request documents from an entity

> Ask the entity's contact for documents via the shared core — emails a
secure portal link. Requires `documents:write`.


Ask the entity's contact for documents — the same flow the in-app "request
documents" action runs. This emails them a secure portal link to upload
against. Provide items inline, or reference a saved document `packageId`.
Requires the `documents:write` scope.


## OpenAPI

````yaml POST /entities/{id}/document-requests
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}/document-requests:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Entity identifier (UUID or your `external_id`).
    post:
      tags:
        - Entities
      summary: Request documents from an entity's contact
      description: |
        Ask the entity's contact for documents via the shared core — emails a
        secure portal link. Requires `documents:write`.
      operationId: createEntityDocumentRequest
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentRequest'
            example:
              title: Company constitution
              items:
                - label: Signed constitution (PDF)
                  required: true
      responses:
        '201':
          description: The document request that was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
components:
  parameters:
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: false
      schema:
        type: string
        maxLength: 255
      description: |
        Caller-supplied unique key for safe retries. Repeat the same key
        within 24 hours and we replay the original response instead of
        repeating the side effect. Reusing the key with a *different*
        request body returns **409 idempotency_conflict**.
  schemas:
    CreateDocumentRequest:
      type: object
      required:
        - title
      additionalProperties: false
      description: Provide at least one inline `item`, or a `packageId`.
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 255
        note:
          type: string
          maxLength: 2000
        items:
          type: array
          maxItems: 50
          items:
            type: object
            required:
              - label
            additionalProperties: false
            properties:
              label:
                type: string
                minLength: 1
                maxLength: 255
              instructions:
                type: string
                maxLength: 1000
              required:
                type: boolean
        packageId:
          type: string
          format: uuid
          description: Reference a saved document package instead of inline items.
    DocumentRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        note:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - SUBMITTED
            - COMPLETE
            - CANCELLED
        recipient_name:
          type: string
          nullable: true
        recipient_email:
          type: string
          nullable: true
        requested_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        items:
          type: array
          items:
            $ref: '#/components/schemas/DocumentRequestItem'
    DocumentRequestItem:
      type: object
      description: >-
        One thing to collect. The file itself is never returned — only its
        status.
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
        instructions:
          type: string
          nullable: true
        required:
          type: boolean
        status:
          type: string
          enum:
            - REQUESTED
            - UPLOADED
            - ACCEPTED
            - REJECTED
            - DISMISSED
        has_upload:
          type: boolean
          description: Whether a file has been uploaded (the file is not returned).
        uploaded_at:
          type: string
          format: date-time
          nullable: true
        reviewed_at:
          type: string
          format: date-time
          nullable: true
    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.
    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_…`.

````