> ## 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. # Search PIX keys > Searches PIX keys by optional key type, status, and participant ISPB filters. ## OpenAPI ````yaml en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/search 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, infraction reports, refunds, fraud markers, synchronous DICT reports, and the internal reconciliation and provisioning 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://spi.sandbox.lerian.net 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: create, 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: >- 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: reconciliation runs, participant ISPB provisioning, claim deadline processing, and orphaned-key cleanup. name: Internal paths: /api/v1/dict/keys/search: get: tags: - Keys summary: Search PIX keys description: >- Searches PIX keys by optional key type, status, and participant ISPB filters. operationId: searchKeys parameters: - description: Page size (default 25, max 100) explode: false in: query name: limit schema: default: 25 description: Page size (default 25, max 100) format: int64 maximum: 100 minimum: 1 type: integer - description: Page offset (default 0) explode: false in: query name: offset schema: default: 0 description: Page offset (default 0) format: int64 minimum: 0 type: integer - description: Filter by PIX key type explode: false in: query name: keyType schema: description: Filter by PIX key type enum: - '' - CPF - CNPJ - PHONE - EMAIL - EVP type: string - description: Filter by key status explode: false in: query name: status schema: description: Filter by key status enum: - '' - ACTIVE - INACTIVE - PENDING_CLAIM - PENDING_BACEN_SYNC type: string - description: Filter by participant ISPB (8-digit institution code) explode: false in: query name: participantISPB schema: description: Filter by participant ISPB (8-digit institution code) type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeyListResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: KeyListResponse: additionalProperties: false properties: correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. type: string items: description: PIX keys for the requested limit/offset window. items: $ref: '#/components/schemas/PIXKeyResponse' type: - array - 'null' limit: description: Effective page size applied to this response. format: int64 type: integer offset: description: Zero-based offset of the first item in this page. format: int64 type: integer required: - items - limit - offset type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 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 type: object 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, TRAN, SLRY, SVGS), omitted for a tuple-less key. enum: - CACC - TRAN - SLRY - SVGS examples: - CACC type: string branch: description: Account branch (1..4 digits), omitted when unset. examples: - '0001' type: string createdAt: description: Key creation timestamp, RFC 3339 (UTC). examples: - '2025-03-07T14:30:00Z' type: string id: description: Unique PIX key identifier (UUID) assigned by the service. examples: - 550e8400-e29b-41d4-a716-446655440000 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 (CPF or CNPJ), digits only. examples: - '12345678901' type: string ownerTradeName: description: Owner trade name (legal-entity owners), omitted when unset. examples: - Silva ME type: string participantISPB: description: Owning participant ISPB, the 8-digit BACEN institution identifier. examples: - '12345678' type: string status: description: >- Key lifecycle status: ACTIVE, INACTIVE, PENDING_CLAIM, or PENDING_BACEN_SYNC. 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 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 securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````