Skip to main content
DELETE
Revoga uma chave de API.

Authorizations

Authorization
string
header
required

Duas credenciais são aceitas no cabeçalho Authorization: Bearer ...: sua chave de API (prefixo sk_, criada no painel ou pelos endpoints de Chaves de API) ou um access token OAuth 2.1 do ZapSign ID (Authorization Code + PKCE S256, emissor https://id.zapsign.com.br, audiência https://api.id.zapsign.com.br/v1). Tokens OAuth carregam os escopos validations:read (consultas) e validations:write (criação e verificação) e não têm acesso aos endpoints de Chaves de API — esses exigem chave sk_ com full_access. Token OAuth rejeitado responde 401 com code invalid_token; escopo insuficiente responde 403 com code insufficient_scope e o cabeçalho WWW-Authenticate indicando o escopo exigido. Descoberta: https://id.zapsign.com.br/.well-known/oauth-authorization-server (servidor de autorização, RFC 8414) e https://api.id.zapsign.com.br/.well-known/oauth-protected-resource/v1 (recurso protegido, RFC 9728). Disponibilidade: o OAuth entra em produção na próxima publicação da plataforma; antes de integrar, confirme que os URLs de descoberta respondem JSON (e não 404) e, enquanto isso, autentique com a chave sk_.

Path Parameters

id
string
required

Identificador da chave de API.

Response

Chave revogada.

Confirmação de revogação.

object
enum<string>
required

Sempre api_key.

Available options:
api_key
id
string
required

Identificador da chave revogada.

Example:

"key_0VH6KAMHAE8HTD08DB9XVZEN3P"

deleted
enum<boolean>
required

Sempre true numa revogação bem-sucedida.

Available options:
true