Versões e mudanças
Versão atual da especificação: 1.0.0 · prefixo /api/public/v1
Política de compatibilidade
- Mudanças compatíveis (campos opcionais novos, novos códigos de erro, novos endpoints) entram na v1 sem aviso prévio de quebra — trate campos desconhecidos de forma tolerante.
- Mudanças incompatíveis ganham um novo prefixo de versão (/api/public/v2/...); a versão anterior segue disponível durante a transição.
- Códigos de erro só são removidos em uma nova versão maior.
- Trate qualquer resposta 5xx como transitória e repita a chamada com o mesmo idempotency_key.
Histórico
v1.0.0
- Publicação da API v1: /consents, /documents, /status, /process, /magic-link e /erasure.
- Assinatura HMAC-SHA256 obrigatória em todos os endpoints, com janela de 5 minutos.
- Idempotência por idempotency_key e deduplicação por hash do arquivo.
- Especificação OpenAPI 3.1 publicada em /api/public/v1/openapi.json.