Registrar decisão sobre solicitação de consulta de CPR na CERC

POST

/v2/cpr/update-status

Registra a decisão sobre uma solicitação de consulta de CPR na CERC. requestId é o id da solicitação (o id devolvido pela listagem e pela consulta de solicitações); authorizationStatus é Autorizado ou Não autorizado; authorizedBy é quem tomou a decisão, em texto livre; authorizationFile, opcional, é o endereço do arquivo da autorização. A rota busca a solicitação no serviço de CPRs na CERC e envia uma nova consulta com a decisão. A resposta 200 confirma o envio da solicitação de atualização, não a conclusão dela. Corpo inválido devolve 422. Quando o serviço de CPRs na CERC responde com erro, a API devolve o mesmo status que ele devolveu, ou 500 quando ele não responde, com a mensagem Falha na integração com o serviço de consulta de CPRs na CERC. seguida de Erro: e a descrição do erro, em message como lista dentro de lista (formato mostrado nas respostas). Solicitação sem dados completos também devolve 500. 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

Solicitação de atualização enviada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠422Corpo inválido

🔴500Falha na integração com a CERC ou erro interno

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/cpr/update-status' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "3f2a9c10-7b5d-4e86-a1c4-9d0e5b7f2a63",
    "authorizationStatus": "Autorizado",
    "authorizationFile": "clients/0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22/autorizacao.pdf",
    "authorizedBy": "Maria Exemplo da Silva"
}'

Response Example

200 - Sucesso

{
    "message": "Solicitação de atualização de CPR feita com sucesso."
}

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

Página anterior

Desvincular matrícula de um contrato

Próxima página

Listar CPRs de um cliente