← Voltar para a visão geral

Público

1 endpoint

Endpoints sem autenticação para o morador

POST/api/v1/public/2a-via

2ª via por CPF para autoatendimento do morador (resposta segura sob LGPD)

CPF/CNPJ não encontrado retorna 200 com lista vazia, nunca confirma se um documento existe. Rate limited a 5 tentativas/min por (IP, documento) e 20/min por IP. Cada consulta é auditada (documento hasheado). Os links de pagamento (PIX e boleto) são URLs assinadas e temporárias (expiram em 30 min) que redirecionam para o gateway, em vez de expor os links permanentes.

Sem autenticação
Headers
Content-TypeObrigatórioapplication/json
Idempotency-KeyRecomendadoULID, janela de 24h
X-Request-IdOpcionalEcoado na resposta
Corpo da requisição*
CampoTipoRestriçõesDescrição
cpf_or_cnpj*string—CPF ou CNPJ, formatação aceita. Alias: document
condominium_slug*string—Public id do condomínio. Alias: condominium_id
Respostas