Registrar aceite ou recusa dos termos de uso

POST

/v2/terms/accept

Registra a resposta do usuário autenticado aos termos de uso da plataforma, na versão vigente. Envie em termDate a data de versão dos termos exibidos ao usuário e em accepted true para aceitar ou false para recusar. A data precisa ser exatamente a da versão vigente; outra data, ou a ausência do campo, devolve 400 (Data dos termos inválida.). O registro guarda também o endereço IP, o navegador (User-Agent) e a identificação do dispositivo de onde veio a resposta. O aceite vale para o usuário na empresa dele: aceitar de novo a mesma versão não gera novo registro e devolve signedAgreement true. Uma recusa devolve signedAgreement false e fica registrada, mas não desfaz um aceite anterior da mesma versão. Para saber se o usuário já aceitou, use a rota de verificar aceite dos termos de uso. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Resposta registrada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Data dos termos inválida

🟠422Campos inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/terms/accept' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "termDate": "2026-01-15",
    "accepted": true
}'

Response Example

200 - Termos aceitos

{
    "signedAgreement": true
}

Modificado em 2026-10-13 09:47:06

Página anterior

Registrar cessão de CPR Ag de um cliente

Próxima página

Verificar aceite dos termos de uso