> ## 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 CID set events at BACEN > Reads one page of BACEN's listCidSetEvents for the X-ISPB participant and one key type: the CIDs added to and removed from its set, ordered by timestamp, with BACEN's sync verifiers before and after the page. Page with startTime while hasMoreElements is true. ## OpenAPI ````yaml /es/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/events openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for the DICT (Diretório de Identificadores de Contas Transacionais) capability of Lerian SPI, the direct integration between the institution and the Brazilian Instant Payment System (SPI/Pix). It covers the PIX key lifecycle, portability and ownership claims, the MED 2.0 dispute surface (infraction reports, refunds, fraud markers, and funds recoveries), antifraud statistics, synchronous DICT reports, and the internal operations that keep the key directory consistent. license: name: Lerian Studio General License title: Lerian SPI — DICT API version: 1.0.0 servers: - url: https://api.example.com description: >- Replace the example host with the URL provided during environment onboarding. security: [] tags: - description: 'PIX key lifecycle: register, list, search, lookup, delete, and statistics.' name: Keys - description: >- PIX key portability and ownership claims through their full lifecycle (initiate, confirm, reject, cancel, acknowledge, complete). name: Claims - description: 'DICT infraction reports: list and retrieve.' name: Infractions - description: 'DICT refund requests: create, list, and retrieve.' name: Refunds - description: 'PIX fraud markers: create, list, and statistics.' name: Fraud Markers - description: >- Durable MED operation-intent status: the operationId every create/lifecycle-transition backlog route returns or references on every outcome, queryable independently of the business resource. name: Operations - description: >- Synchronous reports over Lerian SPI's own DICT record: COUNT(*) summaries of keys (by type/status) and claims (by type/status + open-past-deadline). COUNT-only — DICT holds no money. name: Reports - description: 'Internal DICT operations: claim deadline processing.' name: Internal - description: >- DICT synchronism checks transported to BACEN for the participant named in X-ISPB: sync verification, CID resolution and CID set events, projected verbatim. name: VSync paths: /api/v1/dict/cids/events: get: tags: - VSync summary: List CID set events at BACEN description: >- Reads one page of BACEN's listCidSetEvents for the X-ISPB participant and one key type: the CIDs added to and removed from its set, ordered by timestamp, with BACEN's sync verifiers before and after the page. Page with startTime while hasMoreElements is true. operationId: listDICTCidSetEvents parameters: - description: >- ISPB of the participant the call acts for. It must be this deployment's direct participant or an indirect it sponsors; the body never carries it. in: header name: X-ISPB required: true schema: description: >- ISPB of the participant the call acts for. It must be this deployment's direct participant or an indirect it sponsors; the body never carries it. examples: - '12345678' pattern: ^[0-9A-Z]{8}$ type: string - description: Key type of the CID set. explode: false in: query name: keyType required: true schema: description: Key type of the CID set. enum: - CPF - CNPJ - EMAIL - PHONE - EVP examples: - CPF type: string - description: >- Inclusive lower bound on the event timestamp; omit to start at the oldest event BACEN holds. explode: false in: query name: startTime schema: description: >- Inclusive lower bound on the event timestamp; omit to start at the oldest event BACEN holds. examples: - '2026-09-28T00:00:00Z' format: date-time type: string - description: >- Inclusive upper bound on the event timestamp; omit for no upper bound. explode: false in: query name: endTime schema: description: >- Inclusive upper bound on the event timestamp; omit for no upper bound. examples: - '2026-09-28T23:59:59Z' format: date-time type: string - description: Maximum events per page (1..200, default 100). explode: false in: query name: limit schema: default: 100 description: Maximum events per page (1..200, default 100). examples: - 100 format: int64 maximum: 200 minimum: 1 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CidSetEventsResponse' description: OK '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '429': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Too Many Requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: CidSetEventsResponse: additionalProperties: false properties: bacen: $ref: '#/components/schemas/BACENEnvelopeResponse' description: >- BACEN's operational envelope for this call; omitted when BACEN sent no correlation id. cidSetEvents: description: The events, ordered by timestamp; empty when BACEN lists none. items: $ref: '#/components/schemas/CidSetEventResponse' type: array endTime: description: Timestamp of the last event in the page, BACEN's wire value. examples: - '2026-09-28T23:59:59.999Z' type: string hasMoreElements: description: >- True when BACEN holds more events after this page; ask again from endTime. examples: - false type: boolean keyType: description: Key type of the CID set. examples: - CPF type: string participant: description: ISPB whose CID set the events belong to. examples: - '12345678' type: string startTime: description: Timestamp of the first event in the page, BACEN's wire value. examples: - '2026-09-28T00:00:00.000Z' type: string syncVerifierEnd: description: BACEN's sync verifier of the set after the last event. examples: - cb4f8a1d9e3b27c05f6a4d8e2b1c7f90a3e5d6b8c2f4a1e7d9b3c5f8a2e4d6b1 type: string syncVerifierStart: description: BACEN's sync verifier of the set before the first event. examples: - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 type: string required: - participant - keyType - startTime - endTime - syncVerifierStart - syncVerifierEnd - hasMoreElements - cidSetEvents type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e 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. required: - correlationId type: object BACENEnvelopeResponse: additionalProperties: false properties: correlationId: description: >- BACEN's own correlation identifier for its most recent interaction on this record — the wire value, distinct from any request-scoped echo. examples: - a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 type: string lastModified: description: >- BACEN's own LastModified for this resource (RFC 3339, UTC) — the version this response reflects; present only on the MED resources (infraction, refund, fraud marker, funds recovery). examples: - '2026-06-14T12:00:00Z' type: string responseTime: description: >- Instant BACEN answered its most recent interaction on this record, RFC 3339 (UTC); omitted when BACEN's response carried no parseable instant. examples: - '2026-06-14T12:00:00Z' type: string required: - correlationId type: object CidSetEventResponse: additionalProperties: false properties: cid: description: CID added to or removed from the set. examples: - 28c06eb41c4dc9c3ae114831efcac7446c8747777fca8b145ecd31ff8480ae88 type: string timestamp: description: When the event happened, BACEN's wire value. examples: - '2026-09-28T10:15:30.123Z' type: string type: description: 'BACEN''s event type, verbatim: ADDED or REMOVED.' examples: - ADDED type: string required: - type - cid - timestamp 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.