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

# Trigger a sync verification

> Starts a sync verification against BACEN. Send `keyType` to verify one scope and create a reconciliation job, or send an empty body (`{}`) to verify every scope that Pix Lerian already knows for your ISPB. Both modes answer `202` with the same `{results: [...]}` shape. In the all-scopes mode each scope resolves on its own to `CREATED`, `ALREADY_ACTIVE`, `SKIPPED_RECENTLY_OK` or `FAILED`, and a failure on one scope never stops the others.

A `keyType` outside the enum answers `400` (`PIX-0003`). In the single-scope mode the call answers `409` (`PIX-0156`) when an active job already exists for the scope, and `422` (`PIX-0174`) when Pix Lerian has not discovered the scope yet. The all-scopes mode reports the same two conditions per scope as `ALREADY_ACTIVE` and `FAILED`.



## OpenAPI

````yaml /en/openapi/v3-current/pix-lerian-dict.yaml post /vsync/actions/verify-sync
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/actions/verify-sync:
    post:
      tags:
        - VSync
      summary: Trigger a sync verification
      description: >-
        Starts a sync verification against BACEN. Send `keyType` to verify one
        scope and create a reconciliation job, or send an empty body (`{}`) to
        verify every scope that Pix Lerian already knows for your ISPB. Both
        modes answer `202` with the same `{results: [...]}` shape. In the
        all-scopes mode each scope resolves on its own to `CREATED`,
        `ALREADY_ACTIVE`, `SKIPPED_RECENTLY_OK` or `FAILED`, and a failure on
        one scope never stops the others.


        A `keyType` outside the enum answers `400` (`PIX-0003`). In the
        single-scope mode the call answers `409` (`PIX-0156`) when an active job
        already exists for the scope, and `422` (`PIX-0174`) when Pix Lerian has
        not discovered the scope yet. The all-scopes mode reports the same two
        conditions per scope as `ALREADY_ACTIVE` and `FAILED`.
      operationId: verifySync
      parameters:
        - description: >-
            REQUIRED. Client-supplied replay key, at most 64 bytes. A request
            without it is refused with PIX-0030 @ 400 before the handler runs.
            Resending the same key and request within 1 hour returns the
            original response, its status included, with X-Idempotency-Replayed:
            true. Reusing the key with a divergent method, path or body, or
            while the first request runs, is PIX-0031 @ 412.
          in: header
          name: X-Idempotency
          required: true
          schema:
            maxLength: 64
            minLength: 1
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifySyncBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifySyncResult'
          description: Accepted
        '400':
          content:
            application/json:
              example:
                code: PIX-0030
                title: Idempotency Key Required
                message: >-
                  The X-Idempotency header is required for this operation and
                  must be within the accepted length.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0003
                title: Bad Request
                status: 400
                detail: >-
                  Your request contains one or more fields with an invalid data
                  type.
                code: PIX-0003
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Bad Request (PIX-0003). X-Idempotency absent or longer than 64 bytes
            (PIX-0030). Legacy {code,title,message} envelope, NOT problem+json.
            Route-guard refusals (PIX-0010) answer in the legacy
            {code,title,message} envelope too.
        '409':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0156
                title: Conflict
                status: 409
                detail: An active reconciliation job already exists for this scope.
                code: PIX-0156
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict (PIX-0156).
        '412':
          content:
            application/json:
              example:
                code: PIX-0031
                title: Idempotency Key Conflict
                message: >-
                  The X-Idempotency header is held by a request still running or
                  whose receipt could not be stored, or was already used with a
                  different request.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
          description: >-
            Refused under this X-Idempotency (PIX-0031): the first request under
            it is still running (with Retry-After: 1), its receipt could not be
            stored and the key is held for the hour, or the request differs from
            the first (method, URL, body, or identity header among X-Account-Id
            / X-Reason / X-End-To-End-Id). An earlier request under this key may
            already have executed. Legacy {code,title,message} envelope, NOT
            problem+json.
        '415':
          content:
            application/json:
              example:
                code: PIX-0016
                title: Unsupported Media Type
                message: >-
                  The request body must be sent with Content-Type:
                  application/json.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
          description: >-
            The non-empty request body is missing an accepted JSON Content-Type
            (PIX-0016), answered in the legacy {code,title,message} envelope
            over application/json, NOT problem+json.
        '422':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0174
                title: Unprocessable Entity
                status: 422
                detail: Unknown ISPB or key type in the requested verify-sync scope.
                code: PIX-0174
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity (PIX-0174).
        '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:
              example:
                type: https://errors.lerian.studio/v1/PIX-0000
                title: Internal Server Error
                status: 500
                detail: internal error
                code: PIX-0000
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error (PIX-0000).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    VerifySyncBody:
      additionalProperties: false
      properties:
        keyType:
          description: >-
            Pix key type of the scope to verify; omit to fan out across every
            scope discovered for the tenant
          examples:
            - CPF
          type: string
      type: object
    VerifySyncResult:
      additionalProperties: false
      properties:
        results:
          description: >-
            Per-scope verification outcomes: exactly one element for an
            explicit-keyType request, one per scope discovered for the tenant
            when keyType was omitted (fan-out)
          items:
            $ref: '#/components/schemas/ScopeOutcome'
          type:
            - array
            - 'null'
      required:
        - results
      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
    ScopeOutcome:
      additionalProperties: false
      properties:
        error:
          type: string
        jobId:
          examples:
            - 019606a1-3b4c-7d8e-9f01-234567890abc
          type: string
        keyType:
          examples:
            - CPF
          type: string
        outcome:
          enum:
            - CREATED
            - ALREADY_ACTIVE
            - SKIPPED_RECENTLY_OK
            - FAILED
          examples:
            - CREATED
          type: string
      required:
        - keyType
        - outcome
      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.