> ## Documentation Index > Fetch the complete documentation index at: https://docs.id.zapsign.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar chaves de API > Percorre as chaves da conta, da mais recente para a mais antiga. ## OpenAPI ````yaml GET /api-keys openapi: 3.1.0 info: title: ID ZapSign version: 1.0.0 description: >- API de validações de identidade da ID ZapSign. Crie validações, consulte o resultado e gerencie suas chaves de API. contact: name: Suporte ID ZapSign url: https://id.zapsign.com.br email: support@zapsign.com.br servers: - url: https://api.id.zapsign.com.br/v1 description: Produção security: - bearerAuth: [] tags: - name: Validações description: Criação e consulta de validações. - name: Chaves de API description: Criação, listagem e revogação de chaves de API. paths: /api-keys: get: tags: - Chaves de API summary: Lista chaves de API por ordem de criação. description: >- Retorna da mais recente para a mais antiga. Nenhuma resposta traz o token completo, só a prévia mascarada. operationId: listApiKeys parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Before' responses: '200': description: Página de chaves de API. content: application/json: schema: $ref: '#/components/schemas/ApiKeyList' examples: primeira_pagina: summary: Duas chaves ativas value: object: list has_more: false data: - object: api_key id: key_0VH6KAMHAE8HTD08DB9XVZEN3P name: Integração backend masked_key: sk_Xhht…Srjc permission: validations_access created_at: '2026-08-01T09:12:00Z' last_used_at: '2026-08-07T14:03:11Z' - object: api_key id: key_6XFXST5AB5B7PCMPVKXHD60XQZ name: Automação de infraestrutura masked_key: sk_T2_5…bEs4 permission: full_access created_at: '2026-07-22T17:40:00Z' last_used_at: null '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' components: parameters: Limit: name: limit in: query required: false description: Quantidade de itens por página. schema: type: integer default: 20 minimum: 1 maximum: 100 After: name: after in: query required: false description: >- Cursor para avançar. Use o `id` do último item da página atual; ele não volta no resultado. schema: type: string Before: name: before in: query required: false description: >- Cursor para voltar. Use o `id` do primeiro item da página atual; ele não volta no resultado. schema: type: string schemas: ApiKeyList: type: object description: Página de chaves de API. required: - object - has_more - data properties: object: type: string enum: - list description: Sempre `list`. has_more: type: boolean description: Indica se há mais itens depois desta página. data: type: array description: Chaves de API desta página. items: $ref: '#/components/schemas/ApiKey' ApiKey: type: object description: Chave de API emitida. Nunca traz o token completo. required: - object - id - name - masked_key - permission - created_at - last_used_at properties: object: type: string enum: - api_key description: Sempre `api_key`. id: type: string description: Identificador único da chave. example: key_0VH6KAMHAE8HTD08DB9XVZEN3P name: type: string description: Nome que você deu à chave. masked_key: type: string description: Prévia mascarada, para reconhecer a chave numa lista. example: sk_Xhht…Srjc permission: type: string enum: - validations_access - full_access description: |- Escopo da chave. | Valor | O que permite | | --- | --- | | `validations_access` | Criar e consultar validações | | `full_access` | O mesmo, mais gerenciar chaves de API | created_at: type: string format: date-time description: Data de criação em ISO-8601. last_used_at: type: - string - 'null' format: date-time description: Data do último uso em ISO-8601, ou `null` se nunca foi usada. ErrorEnvelope: type: object description: >- Formato único de erro. Toda falha da API responde neste formato. A lista completa de `code` está em [Erros](/erros). required: - error properties: error: type: object required: - type - code - message - doc_url - request_id properties: type: type: string enum: - invalid_request - authentication_error - not_found - api_error - idempotency_error - payment_error - rate_limit_error description: >- Categoria do erro. Serve para tratar famílias inteiras sem enumerar cada `code`. code: type: string description: >- Código estável do erro. É o que você deve usar para ramificar no seu código. example: missing_required_param message: type: string description: >- Descrição legível, em inglês. É para diagnóstico, não para mostrar ao usuário final. param: type: string description: O campo que causou o erro, quando aplicável. example: cpf doc_url: type: string description: Link direto para este código nesta documentação. example: https://docs.id.zapsign.com.br/missing_required_param request_id: type: string description: Identificador da requisição. Inclua no contato com o suporte. example: req_3PK3TA2H0MEMTDSAPREHSY4QC4 responses: InvalidRequest: description: Requisição inválida (corpo, parâmetro ou chave de idempotência). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: invalid_request code: missing_required_param message: A required parameter is missing. param: cpf doc_url: https://docs.id.zapsign.com.br/missing_required_param request_id: req_3PK3TA2H0MEMTDSAPREHSY4QC4 Unauthorized: description: Chave de API ausente ou inválida. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: authentication_error code: invalid_api_key message: The API key provided is invalid. doc_url: https://docs.id.zapsign.com.br/invalid_api_key request_id: req_3PK3TA2H0MEMTDSAPREHSY4QC4 Forbidden: description: A chave de API não tem permissão para esta operação. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: invalid_request code: insufficient_permission message: The API key does not have permission to perform this action. doc_url: https://docs.id.zapsign.com.br/insufficient_permission request_id: req_3PK3TA2H0MEMTDSAPREHSY4QC4 TooManyRequests: description: Limite de requisições excedido. Veja [Limites de uso](/limites-de-uso). headers: Retry-After: description: Segundos a aguardar antes de tentar de novo. Presente em todo 429. schema: type: integer minimum: 1 RateLimit-Limit: description: Teto de requisições da classe para a conta. Só no 429 de taxa. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requisições restantes na janela atual. Só no 429 de taxa. schema: type: integer minimum: 0 RateLimit-Reset: description: >- Segundos até o limite se restabelecer por completo. Só no 429 de taxa. schema: type: integer minimum: 0 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: rate_limit_error code: rate_limit_exceeded message: Too many requests. Please retry after the indicated delay. doc_url: https://docs.id.zapsign.com.br/rate_limit_exceeded request_id: req_3PK3TA2H0MEMTDSAPREHSY4QC4 InternalError: description: Erro interno inesperado. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: api_error code: api_error message: An internal error occurred. doc_url: https://docs.id.zapsign.com.br/api_error request_id: req_3PK3TA2H0MEMTDSAPREHSY4QC4 securitySchemes: bearerAuth: type: http scheme: bearer description: >- Sua chave de API no cabeçalho `Authorization: Bearer sk_...`. Crie e revogue chaves no painel ou pelos endpoints de Chaves de API. ````