> ## 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 /pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/reconciliation/full
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/reconciliation/full:
    post:
      tags:
        - Reconciliation
      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)
      operationId: dict-start-full-reconciliation
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullReconciliationOutput'
          description: OK
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullReconciliationOutput'
          description: One or more reconciliation jobs were created
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    FullReconciliationOutput:
      additionalProperties: false
      properties:
        jobs:
          description: Information about the created jobs
          items:
            $ref: '#/components/schemas/FullReconciliationJobInfo'
          type: array
        message:
          description: Details about the reconciliation operation
          examples:
            - Created 2 full reconciliation jobs
          type: string
        skippedKeyTypes:
          description: Key types that were skipped
          items:
            $ref: '#/components/schemas/SkippedKeyTypeInfo'
          type: array
      required:
        - message
        - jobs
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    FullReconciliationJobInfo:
      additionalProperties: false
      properties:
        createdAt:
          description: When the job was created (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        expiresAt:
          description: When the WAITING_FILE status expires (ISO 8601 UTC)
          examples:
            - '2024-01-15T12:30:00Z'
          format: date-time
          type: string
        fileRequestId:
          description: ID returned by BTG for the file request
          examples:
            - 770e8400-e29b-41d4-a716-446655440002
          type: string
        jobId:
          description: ID of the created job (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        keyType:
          description: PIX key type for this job
          examples:
            - CPF
          type: string
        status:
          description: Initial status of the job
          examples:
            - WAITING_FILE
          type: string
      required:
        - jobId
        - keyType
        - status
        - fileRequestId
        - expiresAt
        - createdAt
      type: object
    SkippedKeyTypeInfo:
      additionalProperties: false
      properties:
        keyType:
          description: PIX key type that was skipped
          examples:
            - CNPJ
          type: string
        reason:
          description: Explanation of why the key type was skipped
          examples:
            - Already synchronized (SYNCED)
          type: string
        syncStatus:
          description: Current sync status of this key type
          examples:
            - SYNCED
          type: string
      required:
        - keyType
        - reason
      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.