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

# List events

> Read the durable event feed. Start with start=now before a snapshot bootstrap, then retain resume_cursor after each committed batch. Delivery order is not resource-version order.

Read the durable event feed. Start with start=now before a snapshot bootstrap, then retain resume\_cursor after each committed batch. Delivery order is not resource-version order. All IDs and cursors must belong to the authorized workspace and environment. Required scope: events:read. Billing notifications require billing:read and current Owner authority in addition to event access. Data notifications require data:read. Lists and replays must not reveal unauthorized resource metadata.

Examples use synthetic IDs. Replace them with values returned by your environment.


## OpenAPI

````yaml openapi/amlok.json GET /v1/events
openapi: 3.1.0
info:
  title: AMLOK API
  version: 1.0.0
  description: >-
    AMLOK API: borrower connections, Insights origination, immutable risk
    packages and Signal monitoring. Use your institution-issued API origin.
servers: []
security:
  - BearerAuth: []
paths:
  /v1/events:
    get:
      tags:
        - Events
      summary: List events
      description: >-
        Read the durable event feed. Start with start=now before a snapshot
        bootstrap, then retain resume_cursor after each committed batch.
        Delivery order is not resource-version order. All IDs and cursors must
        belong to the authorized workspace and environment. Required scope:
        events:read. Billing notifications require billing:read and current
        Owner authority in addition to event access. Data notifications require
        data:read. Lists and replays must not reveal unauthorized resource
        metadata.
      operationId: listEvents
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: limit
        - name: borrower_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: borrower id
        - name: type
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: type
        - name: start
          in: query
          required: false
          schema:
            type: string
            enum:
              - now
          description: >-
            Capture the current durable feed position with an empty page before
            initial collection bootstrap. Cannot be combined with cursor. Resume
            with the returned resume_cursor.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  meta:
                    $ref: '#/components/schemas/Meta'
                  page:
                    $ref: '#/components/schemas/EventPage'
                required:
                  - data
                  - meta
                  - page
                additionalProperties: false
              example:
                data:
                  - id: evt_synthetic
                    type: origination.completed
                    occurred_at: '2026-11-06T12:00:00Z'
                    resource_type: origination
                    resource_id: orgn_synthetic
                    resource_version: 4
                    borrower_id: bor_synthetic
                    environment: sandbox
                meta:
                  request_id: req_synthetic
                  schema_version: 1.0.0
                  environment: sandbox
                page:
                  next_cursor: null
                  has_more: false
                  resume_cursor: resume_synthetic
                  resume_expires_at: '2026-12-06T12:00:00Z'
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '400':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: validation_error
                  message: Validation error.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '401':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: unauthenticated
                  message: Unauthenticated.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '403':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: forbidden
                  message: Forbidden.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '404':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: not_found
                  message: Not found.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '409':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: invalid_state
                  message: Invalid state.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '410':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: cursor_expired
                  message: Cursor expired.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '429':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: rate_limited
                  message: Rate limited.
                  retryable: true
                  request_id: req_synthetic
                  field: null
          headers:
            Retry-After:
              description: Minimum delay in seconds before retry.
              schema:
                type: integer
                minimum: 0
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '503':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: temporarily_unavailable
                  message: Temporarily unavailable.
                  retryable: true
                  request_id: req_synthetic
                  field: null
          headers:
            Retry-After:
              description: Minimum delay in seconds before retry.
              schema:
                type: integer
                minimum: 0
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request GET --fail-with-body --max-time 30 \
              "${AMLOK_API_BASE_URL}/v1/events" \
              --header "Authorization: Bearer ${AMLOK_API_KEY}" \
              --header 'Accept: application/json'
        - lang: Python
          source: >
            import os

            import requests


            headers = {'Accept': 'application/json'}

            headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

            response = requests.request('GET', os.environ["AMLOK_API_BASE_URL"]
            + '/v1/events', headers=headers, timeout=30, allow_redirects=False)

            response.raise_for_status()

            print(response.json())
        - lang: JavaScript
          source: >
            const headers = {"Accept": "application/json"};

            headers.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`;

            const response = await fetch(process.env.AMLOK_API_BASE_URL +
            "/v1/events", {
              method: "GET", headers, redirect: "error", signal: AbortSignal.timeout(30000)
            });

            if (!response.ok) throw new Error(`HTTP ${response.status}: ${await
            response.text()}`);

            console.log(await response.json());
components:
  schemas:
    Event:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        type:
          type: string
          enum:
            - embedding_session.completed
            - connection.action_required
            - connection.status_changed
            - origination.action_required
            - origination.status_changed
            - origination.completed
            - origination.failed
            - risk_package.created
            - monitor.status_changed
            - monitoring_run.completed
            - monitoring_run.failed
            - alert.created
            - alert.resolved
            - export.ready
            - export.failed
            - data.updated
            - document.status_changed
            - billing.payment_updated
            - billing.transaction_posted
            - deal_snapshot.created
          description: >-
            Type for Event. Constraints, requiredness and allowed values are
            defined by this schema.
        occurred_at:
          type: string
          minLength: 1
          format: date-time
          description: >-
            Occurred at for Event. Constraints, requiredness and allowed values
            are defined by this schema.
        resource_type:
          type: string
          minLength: 1
          enum:
            - alert
            - billing_payment
            - billing_transaction
            - connection
            - deal_snapshot
            - document
            - embedding_session
            - export
            - monitor
            - monitoring_run
            - origination
            - risk_package
          description: >-
            Resource type for Event. Constraints, requiredness and allowed
            values are defined by this schema.
        resource_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        resource_version:
          type: integer
          minimum: 1
          description: >-
            Resource version for Event. Constraints, requiredness and allowed
            values are defined by this schema.
        borrower_id:
          anyOf:
            - type: string
              minLength: 1
              description: >-
                Opaque identifier, authorized within the API key workspace and
                environment.
            - type: 'null'
          description: >-
            Borrower that owns this resource; must match the key workspace and
            environment.
        environment:
          type: string
          enum:
            - sandbox
            - live
          description: >-
            Environment for Event. Constraints, requiredness and allowed values
            are defined by this schema.
      required:
        - id
        - type
        - occurred_at
        - resource_type
        - resource_id
        - resource_version
        - borrower_id
        - environment
      additionalProperties: false
      description: >-
        Minimal at-least-once notification, without financial payloads, tokens
        or download URLs. Fetch authorized resource detail. Events and delivery
        attempts are different records.
      allOf:
        - if:
            properties:
              type:
                const: embedding_session.completed
          then:
            properties:
              resource_type:
                const: embedding_session
        - if:
            properties:
              type:
                const: connection.action_required
          then:
            properties:
              resource_type:
                const: connection
        - if:
            properties:
              type:
                const: connection.status_changed
          then:
            properties:
              resource_type:
                const: connection
        - if:
            properties:
              type:
                const: origination.action_required
          then:
            properties:
              resource_type:
                const: origination
        - if:
            properties:
              type:
                const: origination.status_changed
          then:
            properties:
              resource_type:
                const: origination
        - if:
            properties:
              type:
                const: origination.completed
          then:
            properties:
              resource_type:
                const: origination
        - if:
            properties:
              type:
                const: origination.failed
          then:
            properties:
              resource_type:
                const: origination
        - if:
            properties:
              type:
                const: risk_package.created
          then:
            properties:
              resource_type:
                const: risk_package
        - if:
            properties:
              type:
                const: monitor.status_changed
          then:
            properties:
              resource_type:
                const: monitor
        - if:
            properties:
              type:
                const: monitoring_run.completed
          then:
            properties:
              resource_type:
                const: monitoring_run
        - if:
            properties:
              type:
                const: monitoring_run.failed
          then:
            properties:
              resource_type:
                const: monitoring_run
        - if:
            properties:
              type:
                const: alert.created
          then:
            properties:
              resource_type:
                const: alert
        - if:
            properties:
              type:
                const: alert.resolved
          then:
            properties:
              resource_type:
                const: alert
        - if:
            properties:
              type:
                const: export.ready
          then:
            properties:
              resource_type:
                const: export
        - if:
            properties:
              type:
                const: export.failed
          then:
            properties:
              resource_type:
                const: export
        - if:
            properties:
              type:
                const: data.updated
          then:
            properties:
              resource_type:
                const: connection
        - if:
            properties:
              type:
                const: document.status_changed
          then:
            properties:
              resource_type:
                const: document
        - if:
            properties:
              type:
                const: billing.payment_updated
          then:
            properties:
              resource_type:
                const: billing_payment
        - if:
            properties:
              type:
                const: billing.transaction_posted
          then:
            properties:
              resource_type:
                const: billing_transaction
        - if:
            properties:
              type:
                const: deal_snapshot.created
          then:
            properties:
              resource_type:
                const: deal_snapshot
    Meta:
      type: object
      properties:
        request_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        schema_version:
          type: string
          minLength: 1
          description: >-
            Schema version for Meta. Constraints, requiredness and allowed
            values are defined by this schema.
        environment:
          type: string
          enum:
            - sandbox
            - live
          description: >-
            Environment for Meta. Constraints, requiredness and allowed values
            are defined by this schema.
      required:
        - request_id
        - schema_version
        - environment
      additionalProperties: false
    EventPage:
      type: object
      properties:
        next_cursor:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Next cursor for EventPage. Constraints, requiredness and allowed
            values are defined by this schema.
        has_more:
          type: boolean
          description: >-
            Has more for EventPage. Constraints, requiredness and allowed values
            are defined by this schema.
        resume_cursor:
          type: string
          minLength: 1
          description: >-
            Durable continuation position, present even on an empty page. Check
            retention before accepting; expired cursors return 410.
        resume_expires_at:
          type: string
          minLength: 1
          description: >-
            Expiration of the returned resume cursor. Poll empty pages too and
            atomically advance the checkpoint.
          format: date-time
      required:
        - next_cursor
        - has_more
        - resume_cursor
        - resume_expires_at
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          enum:
            - validation_error
            - unauthenticated
            - forbidden
            - not_found
            - invalid_state
            - idempotency_conflict
            - insufficient_credits
            - precondition_failed
            - cursor_expired
            - rate_limited
            - temporarily_unavailable
            - deal_snapshot_conflict
            - payload_too_large
            - unsupported_media_type
            - document_rejected
            - processing_failed
            - session_expired
            - consent_purpose_missing
            - sandbox_only
            - scenario_not_available
            - idempotency_result_expired
          description: >-
            Code for Error. Constraints, requiredness and allowed values are
            defined by this schema.
        message:
          type: string
          minLength: 1
          description: >-
            Message for Error. Constraints, requiredness and allowed values are
            defined by this schema.
        retryable:
          type: boolean
          description: >-
            Retryable for Error. Constraints, requiredness and allowed values
            are defined by this schema.
        request_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        field:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Field for Error. Constraints, requiredness and allowed values are
            defined by this schema.
      required:
        - code
        - message
        - retryable
        - request_id
        - field
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Server-to-server API key bound to exactly one workspace, institution
        tenant and environment. No caller-supplied workspace override is
        accepted. Do not use in public browser code.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.