Desvincula do contrato a matrícula analisada informada em id, que precisa ser do cliente informado em clientId e não ter sido removida; do contrário, 404 (Matrícula não encontrada.). Se a matrícula já não estiver vinculada a nenhum contrato, a resposta é a mesma, de sucesso. A resposta traz success (sempre verdadeiro) e message. Requer autenticação via Bearer JWT ou header x-api-key e a permissão de desvincular matrículas de clientes. Usuário inativo devolve 404 (Usuário não encontrado); usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada).
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho
Parâmetros Header
Respostas
🟢200
application/json
Matrícula desvinculada
Bodyapplication/json
🟠400BadRequest
🟠401Unauthorized
🟠404NotFound
🟠429TooManyRequests
🔴500InternalError
🟠400Sem permissão para desvincular matrículas
🟠403Acesso negado
🟠404Usuário ou matrícula não encontrada
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request PUT '/v2/queries/clients//registry-analysis/a3bb189e-8bf9-4388-9912-ace4e6543002/remove-contract' \
--header'x-api-key: SUA_CHAVE_DE_API' \
--header'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso
{"success":true,"message":"Matrícula desvinculada com sucesso."}