Nunciatura Provista

API Documentation V1

Revogar token (convidado)

Invalida o token de compartilhamento apresentado na requisição

Público (token no header, query ou body)

Descrição

Permite que o convidado externo encerre o próprio acesso ao link: o token ativo é revogado (revoked_at) e deixa de funcionar. Equivale à revogação feita pelo informador, com tipo de auditoria distinto (collaborator_self_revoked). Aplicável apenas a questionários compartilháveis (G1Q1/G1Q2) com resposta não finalizada. O token pode ser enviado no header X-Questionnaire-Token, na query ?token=... ou no body token.

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provisao.nabrasil.org.br/v1

ENDPOINT

/questionnaires/by-token/revoke

Body (JSON, opcional)

{
  "token": "opcional se já enviado no header ou query"
}

Resposta 200

{
  "success": true,
  "message": "O acesso por este link foi encerrado. O token não pode mais ser utilizado."
}

Códigos de Resposta

Código Descrição
200 Token invalidado (idempotente se já não havia token ativo)
401 Token não fornecido ou inválido/expirado
403 Questionário não compartilhável ou já finalizado