curl --request DELETE \
--url https://api.id.zapsign.com.br/v1/api-keys/{id} \
--header 'Authorization: Bearer <token>'const url = 'https://api.id.zapsign.com.br/v1/api-keys/{id}';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.id.zapsign.com.br/v1/api-keys/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.id.zapsign.com.br/v1/api-keys/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.id.zapsign.com.br/v1/api-keys/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.id.zapsign.com.br/v1/api-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "api_key",
"id": "key_0VH6KAMHAE8HTD08DB9XVZEN3P",
"deleted": true
}{
"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"
}
}{
"error": {
"type": "invalid_request",
"code": "missing_required_param",
"message": "<string>",
"doc_url": "https://docs.id.zapsign.com.br/missing_required_param",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4",
"param": "cpf"
}
}{
"error": {
"type": "not_found",
"code": "not_found",
"message": "No such resource.",
"doc_url": "https://docs.id.zapsign.com.br/not_found",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"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"
}
}{
"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"
}
}Revogar chave de API
A revogação é imediata e definitiva. Requisições feitas com a chave revogada passam a responder 401.
curl --request DELETE \
--url https://api.id.zapsign.com.br/v1/api-keys/{id} \
--header 'Authorization: Bearer <token>'const url = 'https://api.id.zapsign.com.br/v1/api-keys/{id}';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.id.zapsign.com.br/v1/api-keys/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.id.zapsign.com.br/v1/api-keys/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.id.zapsign.com.br/v1/api-keys/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.id.zapsign.com.br/v1/api-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "api_key",
"id": "key_0VH6KAMHAE8HTD08DB9XVZEN3P",
"deleted": true
}{
"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"
}
}{
"error": {
"type": "invalid_request",
"code": "missing_required_param",
"message": "<string>",
"doc_url": "https://docs.id.zapsign.com.br/missing_required_param",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4",
"param": "cpf"
}
}{
"error": {
"type": "not_found",
"code": "not_found",
"message": "No such resource.",
"doc_url": "https://docs.id.zapsign.com.br/not_found",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"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"
}
}{
"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"
}
}Authorizations
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
Identificador da chave de API.
Was this page helpful?