> ## 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 data changes

> Resume from the changes_cursor returned by a completed data snapshot, then persist resume_cursor after applying each batch. Includes upserts, source removals and access changes; expired or mismatched cursors fail explicitly.

Resume from the changes\_cursor returned by a completed data snapshot, then persist resume\_cursor after applying each batch. Includes upserts, source removals and access changes; expired or mismatched cursors fail explicitly. All IDs and cursors must belong to the authorized workspace and environment. Required scope: data:read.

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


## OpenAPI

````yaml openapi/amlok.json GET /v1/data/changes
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/data/changes:
    get:
      tags:
        - Data
      summary: List data changes
      description: >-
        Resume from the changes_cursor returned by a completed data snapshot,
        then persist resume_cursor after applying each batch. Includes upserts,
        source removals and access changes; expired or mismatched cursors fail
        explicitly. All IDs and cursors must belong to the authorized workspace
        and environment. Required scope: data:read.
      operationId: listDataChanges
      parameters:
        - name: cursor
          in: query
          required: true
          schema:
            type: string
            minLength: 1
          description: >-
            Use data snapshot changes_cursor, then change-feed resume_cursor.
            Bound filters and borrower are encoded in the cursor; no arbitrary
            time or filter reset.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: limit
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataChange'
                  meta:
                    $ref: '#/components/schemas/Meta'
                  page:
                    $ref: '#/components/schemas/DataChangePage'
                required:
                  - data
                  - meta
                  - page
                additionalProperties: false
              example:
                data:
                  - id: change_synthetic
                    type: upsert
                    occurred_at: '2026-11-06T12:00:00Z'
                    record_id: dr_synthetic_v1
                    borrower_id: bor_synthetic
                    resource_id: txn_synthetic
                    resource_type: bank_transaction
                    record_version: 1
                    reason: null
                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/data/changes?cursor=data_cursor_synthetic" \
              --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/data/changes?cursor=data_cursor_synthetic', 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/data/changes?cursor=data_cursor_synthetic", {
              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:
    DataChange:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: Stable change notification ID for idempotent processing.
        type:
          type: string
          enum:
            - upsert
            - removed
            - access_changed
          description: >-
            upsert supplies a record version; removed and access_changed require
            reconciliation of a prior local record.
        occurred_at:
          type: string
          minLength: 1
          format: date-time
          description: UTC time this change was committed to the data feed.
        record_id:
          anyOf:
            - type: string
              minLength: 1
              description: Opaque ID within the authorized workspace and environment.
            - type: 'null'
          description: >-
            Exact DataRecord version to fetch; can be null for a removal or
            access restriction.
        borrower_id:
          type: string
          minLength: 1
          description: Opaque ID within the authorized workspace and environment.
        resource_id:
          type: string
          minLength: 1
          description: Opaque ID within the authorized workspace and environment.
        resource_type:
          type: string
          minLength: 1
          description: >-
            Resource type for DataChange. Constraints, requiredness and allowed
            values are defined by this schema.
        record_version:
          type: integer
          minimum: 1
          description: Monotonic resource version for event reconciliation.
        reason:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: Reason for removal or access change when applicable.
      required:
        - id
        - type
        - occurred_at
        - record_id
        - borrower_id
        - resource_id
        - resource_type
        - record_version
        - reason
      additionalProperties: false
      description: >-
        Ordered change notification for a logical record. upsert references an
        immutable DataRecord version. Removal and access changes can expose
        metadata only; purge affected local copies as required by the
        authorization/retention policy. Reading a feed never restores access.
      allOf:
        - if:
            properties:
              type:
                const: upsert
          then:
            properties:
              record_id:
                type: string
                minLength: 1
                description: Opaque ID within the authorized workspace and environment.
          else:
            properties:
              reason:
                type: string
                minLength: 1
    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
    DataChangePage:
      type: object
      properties:
        next_cursor:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Next cursor for DataChangePage. Constraints, requiredness and
            allowed values are defined by this schema.
        has_more:
          type: boolean
          description: >-
            Has more for DataChangePage. Constraints, requiredness and allowed
            values are defined by this schema.
        resume_cursor:
          type: string
          minLength: 1
          description: >-
            Commit after applying the full batch. Present even for an empty
            page; pass as cursor for the next request.
        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.