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

> Returns a page of the reconciliation jobs of a scope (ISPB and key type). Filter by status and by job ID.



## OpenAPI

````yaml /es/openapi/v3-current/pix-lerian-dict.yaml get /vsync/jobs
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.2.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/jobs:
    get:
      tags:
        - VSync
      summary: List reconciliation jobs
      description: >-
        Returns a page of the reconciliation jobs of a scope (ISPB and key
        type). Filter by status and by job ID.
      operationId: listReconciliationJobs
      parameters:
        - description: Key type
          explode: false
          in: query
          name: key_type
          required: true
          schema:
            description: Key type
            examples:
              - CPF
            type: string
        - description: Filter by specific job ID (UUID)
          explode: false
          in: query
          name: job_id
          schema:
            description: Filter by specific job ID (UUID)
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
        - description: Filter by job status
          explode: false
          in: query
          name: status
          schema:
            description: Filter by job status
            examples:
              - COMPLETED
            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/ListReconciliationJobsOutput'
          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:
    ListReconciliationJobsOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReconciliationJobItem'
          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
    ReconciliationJobItem:
      additionalProperties: false
      properties:
        addedCount:
          description: >-
            FILE_RECONCILIATION only: entries the job created or replaced at the
            hub; 0 for other job types
          examples:
            - 12
          format: int64
          type: integer
        attempt:
          examples:
            - 1
          format: int64
          type: integer
        completedAt:
          examples:
            - '2026-04-20T10:05:30Z'
          format: date-time
          type: string
        createdAt:
          examples:
            - '2026-04-20T09:59:00Z'
          format: date-time
          type: string
        error:
          examples:
            - ''
          type: string
        id:
          examples:
            - 019606a1-3b4c-7d8e-9f01-234567890abc
          type: string
        ispb:
          examples:
            - '30306294'
          type: string
        jobType:
          examples:
            - FILE_RECONCILIATION
          type: string
        keyType:
          examples:
            - CPF
          type: string
        maxAttempts:
          examples:
            - 3
          format: int64
          type: integer
        removedCount:
          description: >-
            FILE_RECONCILIATION only: hub entries the job soft-deleted, each
            once, including the old entry of a replaced key; 0 for other job
            types
          examples:
            - 3
          format: int64
          type: integer
        startedAt:
          examples:
            - '2026-04-20T10:00:00Z'
          format: date-time
          type: string
        status:
          examples:
            - COMPLETED
          type: string
        updatedAt:
          examples:
            - '2026-04-20T10:05:30Z'
          format: date-time
          type: string
      required:
        - id
        - ispb
        - keyType
        - jobType
        - status
        - attempt
        - maxAttempts
        - addedCount
        - removedCount
        - createdAt
        - updatedAt
      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.