> ## 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. # Listar claves > Enumera todas las claves Pix registradas en una cuenta. Devuelve un arreglo de entradas de claves Pix, cada una con su código de estado actual (consulta KeyStatusEnum para los valores: -1=CANCELLED, 0=FINALIZED, 1=ACTIVE, etc.). ## OpenAPI ````yaml es/openapi/v3-current/pix.yaml GET /v1/entries openapi: 3.0.3 info: title: Plugin BR Pix Directo - API completa description: > API completa para el sistema de pagos instantáneos Pix de Brasil, que incluye operaciones del diccionario de claves Pix, generación/decodificación de códigos QR, transacciones y límites transaccionales. version: 1.0.0 servers: - url: https://plugin-pix-direct.api.lerian.net - url: https://plugin-pix-direct-qrcode.api.lerian.net security: - bearerAuth: [] paths: /v1/entries: get: tags: - Key DICT API summary: Listar claves description: > Enumera todas las claves Pix registradas en una cuenta. Devuelve un arreglo de entradas de claves Pix, cada una con su código de estado actual (consulta KeyStatusEnum para los valores: -1=CANCELLED, 0=FINALIZED, 1=ACTIVE, etc.). parameters: - $ref: '#/components/parameters/AccountIdQuery' responses: '200': description: Claves Pix recuperadas correctamente content: application/json: schema: type: array items: $ref: '#/components/schemas/PixKeyEntry' example: - key: '+5511987654321' status: 1 statusDescription: ACTIVE comment: >- status 1 = ACTIVE - la clave telefónica está activa y operativa - key: user@example.com status: 1 statusDescription: ACTIVE comment: >- status 1 = ACTIVE - la clave de correo electrónico está activa y operativa - key: '12345678901' status: 0 statusDescription: FINALIZED comment: status 0 = FINALIZED - clave CPF pendiente de confirmación '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' components: parameters: AccountIdQuery: name: account_id in: query required: false description: Identificador de la cuenta. schema: type: string format: uuid example: 019c96a0-0a98-7287-9a31-786e0809c769 schemas: PixKeyEntry: type: object required: - key - status - statusDescription properties: key: type: string description: Valor de la clave Pix. example: '+5511987654321' status: $ref: '#/components/schemas/KeyStatusEnum' statusDescription: type: string description: Descripción legible del estado que corresponde al código numérico. example: REGISTERED KeyStatusEnum: type: integer description: > Código de estado del registro de la clave Pix. Indica el estado actual de una clave Pix en su ciclo de vida. **Valores válidos:** - `-1` = CANCELLED (El registro de la clave fue cancelado) - `0` = FINALIZED (La clave está finalizada/pendiente de confirmación) - `1` = ACTIVE (La clave está activa y operativa) - `2` = WAITING_OWNERSHIP_CONFIRMATION (En espera de la confirmación de titularidad por parte del usuario) - `3` = CREATING (La clave se está creando en el sistema) - `4` = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Soy reclamante, pendiente de confirmación del reclamo) - `5` = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Soy reclamante, esperando que el titular actual libere la clave) - `6` = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Soy titular, pendiente de aprobar la transferencia de la clave) - `7` = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, a la espera de mi confirmación) enum: - -1 - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 x-enum-varnames: - CANCELLED - FINALIZED - ACTIVE - WAITING_OWNERSHIP_CONFIRMATION - CREATING - IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST - IM_CLAIMER_PENDING_OWNER_GIVEWAY - IM_OWNER_PENDING_GIVEAWAY_CONFIRM - IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM example: 1 ErrorResponse: type: object properties: code: type: string description: Código de error message: type: string description: Mensaje de error details: type: array items: type: string description: Detalles adicionales del error responses: Unauthorized: description: No Autorizado - Autenticación inválida o ausente content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_token: summary: Missing authentication token value: code: MISSING_TOKEN message: Authorization header is required details: [] invalid_token: summary: Invalid token value: code: INVALID_TOKEN message: Invalid or expired access token details: [] expired_token: summary: Expired token value: code: TOKEN_EXPIRED message: Access token has expired. Please obtain a new token. details: [] NotFound: description: No Encontrado - El recurso no existe content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: pix_key_not_found: summary: Pix key not found value: code: PIX_KEY_NOT_FOUND message: PIX key does not exist or is not registered details: [] account_not_found: summary: Account not found value: code: ACCOUNT_NOT_FOUND message: Account with specified ID does not exist details: [] transaction_not_found: summary: Transaction not found value: code: TRANSACTION_NOT_FOUND message: Transaction not found details: [] InternalServerError: description: Error Interno del Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: generic_error: summary: Generic internal error value: code: INTERNAL_ERROR message: An internal error occurred. Please try again later. details: [] database_error: summary: Database error value: code: DATABASE_ERROR message: Database operation failed details: [] external_service_error: summary: External service error value: code: EXTERNAL_SERVICE_ERROR message: External service (JD PIX) is temporarily unavailable details: [] securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Autenticación con token JWT Bearer. Obtén el token desde el endpoint `/v1/login/oauth/access_token` usando credenciales de cliente (`clientId` y `clientSecret`). Incluye el token en el encabezado Authorization: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` El token expira después de 3600 segundos (1 hora). ````