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

# List reconciliation logs

> Returns a page of reconciliation audit logs, newest first, one row per outcome. Filter by outcome type, key type, job ID and date range. Personal data in the details is masked.

The outcome types are `ENTRY_CREATED`, `ENTRY_DELETED`, `ORPHAN_DETECTED`, `DIFFERENCE_DETECTED`, `ENTRY_NOT_FOUND` and `VALIDATION_FAILURE`. `outcome_type` is matched as written and is not validated, so a value that is not one of these returns an empty page, not an error.

`VALIDATION_FAILURE` is the manual-review record. It marks an entry that a reconciliation refused for good and did not apply: an event-feed CID that is not 64 hexadecimal characters or carries an action Pix Lerian does not handle, or a BACEN entry that fails validation, does not produce its CID or belongs to another scope. The reconciliation moves on and nothing applies that entry later, so list `outcome_type=VALIDATION_FAILURE` to find what needs review. `details` names the flow (`event_sync` or `file_reconciliation`), the reason (`invalid_cid`, `unknown_action` or `refused_entry`) and the error.

Only `DIFFERENCE_DETECTED` and `VALIDATION_FAILURE` rows carry `details`.



## OpenAPI

````yaml /es/openapi/v3-current/pix-lerian-dict.yaml get /vsync/reconciliation-logs
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for Pix keys, claims, fraud markers, infraction reports, and MED
    funds recovery.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — DICT
  version: 1.3.0
servers:
  - url: https://api.example.com/dict-hub/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
  - description: Manage participant-scoped MED 2.0 funds recoveries.
    name: Funds Recoveries
  - description: Manage MED 2.0 infraction reports for the authenticated organization.
    name: Infraction Reports
  - description: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
  - description: >-
      Read the state of key reconciliation against BACEN, and start a
      verification or a file reconciliation.
    name: VSync
paths:
  /vsync/reconciliation-logs:
    get:
      tags:
        - VSync
      summary: List reconciliation logs
      description: >-
        Returns a page of reconciliation audit logs, newest first, one row per
        outcome. Filter by outcome type, key type, job ID and date range.
        Personal data in the details is masked.


        The outcome types are `ENTRY_CREATED`, `ENTRY_DELETED`,
        `ORPHAN_DETECTED`, `DIFFERENCE_DETECTED`, `ENTRY_NOT_FOUND` and
        `VALIDATION_FAILURE`. `outcome_type` is matched as written and is not
        validated, so a value that is not one of these returns an empty page,
        not an error.


        `VALIDATION_FAILURE` is the manual-review record. It marks an entry that
        a reconciliation refused for good and did not apply: an event-feed CID
        that is not 64 hexadecimal characters or carries an action Pix Lerian
        does not handle, or a BACEN entry that fails validation, does not
        produce its CID or belongs to another scope. The reconciliation moves on
        and nothing applies that entry later, so list
        `outcome_type=VALIDATION_FAILURE` to find what needs review. `details`
        names the flow (`event_sync` or `file_reconciliation`), the reason
        (`invalid_cid`, `unknown_action` or `refused_entry`) and the error.


        Only `DIFFERENCE_DETECTED` and `VALIDATION_FAILURE` rows carry
        `details`.
      operationId: listReconciliationLogs
      parameters:
        - description: >-
            Filter by outcome type: ENTRY_CREATED, ENTRY_DELETED,
            ORPHAN_DETECTED, DIFFERENCE_DETECTED, ENTRY_NOT_FOUND or
            VALIDATION_FAILURE. Matched as written; an unknown value returns an
            empty page, not an error
          explode: false
          in: query
          name: outcome_type
          schema:
            description: >-
              Filter by outcome type: ENTRY_CREATED, ENTRY_DELETED,
              ORPHAN_DETECTED, DIFFERENCE_DETECTED, ENTRY_NOT_FOUND or
              VALIDATION_FAILURE. Matched as written; an unknown value returns
              an empty page, not an error
            examples:
              - DIFFERENCE_DETECTED
            type: string
        - description: Filter by key type
          explode: false
          in: query
          name: key_type
          schema:
            description: Filter by key type
            examples:
              - CPF
            type: string
        - description: Filter by job ID (UUID)
          explode: false
          in: query
          name: job_id
          schema:
            description: Filter by job ID (UUID)
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
        - description: Filter from date (YYYY-MM-DD)
          explode: false
          in: query
          name: start_date
          schema:
            description: Filter from date (YYYY-MM-DD)
            examples:
              - '2026-04-01'
            type: string
        - description: Filter to date (YYYY-MM-DD)
          explode: false
          in: query
          name: end_date
          schema:
            description: Filter to date (YYYY-MM-DD)
            examples:
              - '2026-04-20'
            type: string
        - description: Page number (1-based, default 1)
          explode: false
          in: query
          name: page
          schema:
            description: Page number (1-based, default 1)
            examples:
              - '1'
            type: string
        - description: Rows per page (default 10, max 100)
          explode: false
          in: query
          name: limit
          schema:
            description: Rows per page (default 10, max 100)
            examples:
              - '10'
            type: string
        - description: Sort direction (default desc)
          explode: false
          in: query
          name: sort_order
          schema:
            description: Sort direction (default desc)
            examples:
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReconciliationLogsOutput'
          description: OK
        '500':
          content:
            application/json:
              example:
                code: PIX-0000
                title: Internal Server Error
                message: >-
                  The server encountered an unexpected error. Please try again
                  later.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListReconciliationLogsOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReconciliationLogItem'
          type:
            - array
            - 'null'
        limit:
          examples:
            - 10
          format: int64
          type: integer
        page:
          examples:
            - 1
          format: int64
          type: integer
        total:
          examples:
            - 1
          format: int64
          type: integer
      required:
        - items
        - total
        - page
        - limit
      type: object
    LegacyErrorEnvelope:
      additionalProperties: false
      properties:
        code:
          description: PIX-XXXX error code
          type: string
        message:
          description: Human-readable error message
          type: string
        title:
          description: Short error title
          type: string
        fields:
          additionalProperties:
            type: string
          description: Per-field detail, keyed by the field or header the refusal names
          type: object
        headers:
          additionalProperties:
            type: string
          description: Per-header detail, keyed by the request header the refusal names
          type: object
      required:
        - code
        - title
        - message
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ReconciliationLogItem:
      additionalProperties: false
      properties:
        cid:
          examples:
            - a1b2c3d4e5f6a7b8
          type: string
        createdAt:
          examples:
            - '2026-04-20T10:03:15Z'
          format: date-time
          type: string
        details:
          additionalProperties: {}
          type: object
        entryId:
          examples:
            - 019606c3-5d6e-7f80-1b23-456789012cde
          type: string
        id:
          examples:
            - 019606b2-4c5d-7e8f-0a12-345678901bcd
          type: string
        jobId:
          examples:
            - 019606a1-3b4c-7d8e-9f01-234567890abc
          type: string
        keyType:
          examples:
            - CPF
          type: string
        outcomeType:
          examples:
            - DIFFERENCE_DETECTED
          type: string
      required:
        - id
        - keyType
        - outcomeType
        - createdAt
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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