> ## 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. # Get PIX key > Reads one PIX key from this deployment's own key registry and nowhere else: BACEN DICT is never called and no retained BACEN answer is consulted, so the read spends no DICT query token and needs no paying end user. The key is answered in any local status (ACTIVE or PENDING_CLAIM), with the participant's requestId. X-ISPB names the participant asking, authorized like the update verb's: this deployment's own direct participant or an active indirect it sponsors (403 otherwise). A key bound to any other participant answers 404 exactly as a key with no row does, so its existence does not leak. The key travels percent-encoded as a path segment. ## OpenAPI ````yaml /en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/{key} 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/keys/{key}: get: tags: - Keys summary: Get PIX key description: >- Reads one PIX key from this deployment's own key registry and nowhere else: BACEN DICT is never called and no retained BACEN answer is consulted, so the read spends no DICT query token and needs no paying end user. The key is answered in any local status (ACTIVE or PENDING_CLAIM), with the participant's requestId. X-ISPB names the participant asking, authorized like the update verb's: this deployment's own direct participant or an active indirect it sponsors (403 otherwise). A key bound to any other participant answers 404 exactly as a key with no row does, so its existence does not leak. The key travels percent-encoded as a path segment. operationId: getKey parameters: - description: >- ISPB of the participant asking: this deployment's own direct participant or an active indirect it sponsors. Only a key bound to exactly this participant is answered. in: header name: X-ISPB required: true schema: description: >- ISPB of the participant asking: this deployment's own direct participant or an active indirect it sponsors. Only a key bound to exactly this participant is answered. examples: - '12345678' pattern: ^[0-9A-Z]{8}$ type: string - description: >- PIX key value, percent-encoded as a path segment (an e-mail's '@' and '+', a phone's leading '+'); matched in canonical form, as the registry stores it. in: path name: key required: true schema: description: >- PIX key value, percent-encoded as a path segment (an e-mail's '@' and '+', a phone's leading '+'); matched in canonical form, as the registry stores it. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PIXKeyResponse' description: >- The PIX key as this deployment's registry holds it, in any local status 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 '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: PIXKeyResponse: additionalProperties: false properties: accountNumber: description: Account number (1..20 digits), omitted for a tuple-less key. examples: - '9988776' type: string accountType: description: >- BACEN account type (CACC, SVGS, TRAN, SLRY, OTHR), omitted for a tuple-less key. enum: - CACC - SVGS - TRAN - SLRY - OTHR examples: - CACC type: string bacen: $ref: '#/components/schemas/BACENEnvelopeResponse' description: >- BACEN's own operational envelope for its most recent interaction on this key; omitted when no BACEN interaction has ever landed on it. branch: description: Account branch (1..4 digits), omitted when unset. examples: - '0001' type: string createdAt: description: >- Key creation timestamp, RFC 3339 (UTC) — OUR row's local timestamp, not BACEN's; see creationDate for the DICT's own binding-creation instant. examples: - '2025-03-07T14:30:00Z' type: string creationDate: description: >- BACEN's own creation instant for this key/account/owner binding, as the DICT answered it; omitted when BACEN's answer carried none. examples: - '2020-01-15T00:00:00Z' format: date-time type: string id: description: Unique PIX key identifier (UUID) assigned by the service. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string keyOwnershipDate: description: >- Instant from which the owner has held uninterrupted possession of this key per BACEN; may differ from creationDate after a portability. Omitted when BACEN's answer carried none. examples: - '2020-01-15T00:00:00Z' format: date-time type: string keyType: description: 'PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).' examples: - CPF type: string keyValue: description: PIX key value in its canonical format for the key type. examples: - '12345678901' type: string openingDate: description: Account opening date, RFC 3339, omitted for a tuple-less key. examples: - '2020-01-15T00:00:00Z' format: date-time type: string ownerName: description: Full legal name of the key owner. examples: - João Silva type: string ownerTaxId: description: >- Owner tax identifier: 11 digits for a CPF, 14 alphanumeric characters for a CNPJ (IN RFB 2.229/2024). examples: - '12345678901' type: string ownerTradeName: description: Owner trade name (legal-entity owners), omitted when unset. examples: - Silva ME type: string ownerType: description: >- BACEN's own Person discriminator for the owner, as the DICT published it — not the value the registration declared, which is refused when the two could disagree. Omitted when BACEN's answer carried none. enum: - NATURAL_PERSON - LEGAL_PERSON examples: - NATURAL_PERSON type: string participantISPB: description: >- Owning participant ISPB, the BACEN institution identifier (8 digits or uppercase letters). examples: - '12345678' type: string requestId: description: >- The participant's own identifier for the registration that created this binding, echoed back. It is the value BACEN holds against the vinculo for life, so it is what a DICT support case and a retry are addressed by. Omitted for a key registered before this field existed, which had no caller to state one. examples: - b2696bf1-0a51-48b0-ab4a-8af2dff440af format: uuid type: string status: description: 'Key lifecycle status: ACTIVE or PENDING_CLAIM.' examples: - ACTIVE type: string updatedAt: description: Timestamp of the last update to the key, RFC 3339 (UTC). examples: - '2025-03-07T14:30:00Z' type: string required: - id - keyType - keyValue - ownerName - ownerTaxId - participantISPB - status - createdAt - updatedAt 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 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.