Headers de resposta - kycert

Headers enviados em toda resposta

Header	Descrição
`X-Request-Id`	UUID único por request — use em tickets de suporte para rastreamento preciso
`X-Kycert-Api-Version`	Versão da API que processou o request
`X-RateLimit-Limit`	Limite total da janela de rate limit atual
`X-RateLimit-Remaining`	Requisições restantes na janela atual
`X-RateLimit-Reset`	Unix timestamp do momento em que a janela reseta

Headers presentes apenas em respostas específicas:

Header	Quando aparece	Descrição
`Retry-After`	`429` (rate limit)	Segundos a aguardar antes de tentar novamente

Como usar o X-Request-Id

Logue o X-Request-Id em toda requisição. Se um request falhar de forma inesperada, incluir esse ID ao abrir suporte economiza horas de investigação.

const res = await fetch('https://admin.kycert.com.br/api/v1/bureau/runs', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.KYCERT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ template_id, subject }),
})

const requestId = res.headers.get('x-request-id')
console.log(JSON.stringify({ event: 'bureau_run_created', request_id: requestId, status: res.status }))

import requests, os, json

res = requests.post(
    'https://admin.kycert.com.br/api/v1/bureau/runs',
    headers={'x-api-key': os.environ['KYCERT_API_KEY']},
    json={'template_id': template_id, 'subject': subject},
)

request_id = res.headers.get('x-request-id')
print(json.dumps({'event': 'bureau_run_created', 'request_id': request_id, 'status': res.status_code}))

X-Kycert-Api-Version

Confirma qual versão da API processou o request. Útil para verificar se a versão fixada no header x-kycert-api-version do request está sendo respeitada.

curl -s -D - \
  -H "x-api-key: $KYCERT_API_KEY" \
  https://admin.kycert.com.br/api/v1/bureau/runs | head -10
# X-Kycert-Api-Version: 2026-06-03

Veja Autenticação → Versionamento para detalhes sobre como fixar a versão.