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

# Start Full Reconciliation

> Triggers full reconciliation for all key types that are currently out of sync.

This endpoint detects which key types have OUT_OF_SYNC status and requests
CID files from BTG for each of them. The actual reconciliation processing
happens asynchronously via webhooks when the files become available.

**Response codes:**
- **202 Accepted**: One or more reconciliation jobs were created
- **200 OK**: All key types are already synchronized (no jobs created)



## OpenAPI

````yaml en/openapi/v3-current/indirect-pix.yaml POST /v1/dict/reconciliation/full
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/reconciliation/full:
    post:
      tags:
        - Reconciliation API
      summary: Start Full Reconciliation
      description: >-
        Triggers full reconciliation for all key types that are currently out of
        sync.


        This endpoint detects which key types have OUT_OF_SYNC status and
        requests

        CID files from BTG for each of them. The actual reconciliation
        processing

        happens asynchronously via webhooks when the files become available.


        **Response codes:**

        - **202 Accepted**: One or more reconciliation jobs were created

        - **200 OK**: All key types are already synchronized (no jobs created)
      responses:
        '200':
          description: All key types synchronized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullReconciliationOutput'
        '202':
          description: Reconciliation jobs created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullReconciliationOutput'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    FullReconciliationOutput:
      description: Response from full reconciliation start operation.
      properties:
        jobs:
          description: Jobs contains information about the created jobs.
          items:
            $ref: '#/components/schemas/FullReconciliationJobInfo'
          type: array
        message:
          description: "Message provides details about the operation.\n\t@Example\tCreated 2 full reconciliation jobs"
          example: Created 2 full reconciliation jobs
          type: string
        skippedKeyTypes:
          description: SkippedKeyTypes lists key types that were skipped.
          items:
            $ref: '#/components/schemas/SkippedKeyTypeInfo'
          type: array
      type: object
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
    FullReconciliationJobInfo:
      description: Information about a created full reconciliation job.
      properties:
        createdAt:
          description: "CreatedAt is when the job was created.\n\t@Example\t2024-01-15T10:30:00Z"
          example: '2024-01-15T10:30:00Z'
          type: string
        expiresAt:
          description: "ExpiresAt is when the WAITING_FILE status expires.\n\t@Example\t2024-01-15T12:30:00Z"
          example: '2024-01-15T12:30:00Z'
          type: string
        fileRequestId:
          description: "FileRequestID is the ID returned by BTG for the file request.\n\t@Example\t770e8400-e29b-41d4-a716-446655440002"
          example: 770e8400-e29b-41d4-a716-446655440002
          type: string
        jobId:
          description: "JobID is the ID of the created job.\n\t@Example\t550e8400-e29b-41d4-a716-446655440000"
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        keyType:
          description: "KeyType is the Pix key type for this job.\n\t@Example\tCPF"
          example: CPF
          type: string
        status:
          description: "Status is the initial status of the job.\n\t@Example\tWAITING_FILE"
          example: WAITING_FILE
          type: string
      type: object
    SkippedKeyTypeInfo:
      description: Information about a key type that was skipped.
      properties:
        keyType:
          description: "KeyType is the Pix key type.\n\t@Example\tCNPJ"
          example: CNPJ
          type: string
        reason:
          description: "Reason explains why the key type was skipped.\n\t@Example\tAlready synchronized (SYNCED)"
          example: Already synchronized (SYNCED)
          type: string
        syncStatus:
          description: "SyncStatus is the current sync status of this key type.\n\t@Example\tSYNCED"
          example: SYNCED
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````