> ## 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. # Read a CID set file request > Reads a CID set file request as Lerian SPI last recorded it from BACEN, without asking BACEN. The download url is never served. A request of another participant answers 404 SPI-0013. ## OpenAPI ````yaml /pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/files/{id} 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/files/{id}: get: tags: - VSync summary: Read a CID set file request description: >- Reads a CID set file request as Lerian SPI last recorded it from BACEN, without asking BACEN. The download url is never served. A request of another participant answers 404 SPI-0013. operationId: getDICTCidSetFile 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: BACEN's id for the file, as POST cids/files returned it. in: path name: id required: true schema: description: BACEN's id for the file, as POST cids/files returned it. examples: - '4521' pattern: ^[0-9]{1,19}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CidSetFileResponse' description: OK '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '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: CidSetFileResponse: additionalProperties: false properties: bytes: description: >- Size of the file in bytes, as BACEN reported it; omitted until AVAILABLE. examples: - 3200000 format: int64 type: integer creationTime: description: When BACEN generated the file; omitted until it did. examples: - '2026-09-29T12:01:10.5Z' format: date-time type: string id: description: BACEN's id for the file. examples: - '4521' type: string keyType: description: Key type of the CID set. examples: - EMAIL type: string participant: description: ISPB whose CID set the file holds. examples: - '12345678' type: string requestTime: description: When BACEN received the request. examples: - '2026-09-29T12:00:00.123Z' format: date-time type: string sha256: description: SHA-256 of the file, as BACEN reported it; omitted until AVAILABLE. examples: - f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b type: string status: description: >- The last status BACEN reported, verbatim: REQUESTED, PROCESSING, AVAILABLE, UNAVAILABLE or ERROR. examples: - AVAILABLE type: string required: - id - status - participant - keyType - requestTime 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 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.