Reenviar documento de CPR Ag para análise automática

Em teste

PATCH

/v2/cpr-ag/pre-register/{id}

Envia de novo para análise automática uma CPR já existente, informada em id, com o PDF informado em urlDocument, que substitui o documento anterior. Só aceita CPR da empresa do usuário com status rascunho ou erro. A CPR volta ao status processando, o preço fixo da análise é debitado de novo do saldo da empresa e o documento é enviado para processamento: a resposta 200 indica que o pedido foi aceito, não que a análise terminou. CPR inexistente, de outra empresa ou em outro status devolve 404 (CPR não pode ser atualizada.). A rota não confere se o arquivo existe nem se é PDF. 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 de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Análise solicitada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Envio recusado

🟠404Recurso da análise não encontrado

🟠422Documento não informado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/cpr-ag/pre-register/3f2b8c1e-0000-4000-8000-00000000c002' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "urlDocument": "https://files.example.com/cpr/cpr-0002.pdf"
}'

Response Example

200 - Sucesso

{
    "_id": "3f2b8c1e-0000-4000-8000-00000000c002",
    "status": "processando",
    "urlDocument": "https://files.example.com/cpr/cpr-0002.pdf",
    "createdAt": "2026-10-01T12:00:00.000Z",
    "userRegisterName": "Maria Exemplo",
    "updatedAt": "2026-10-02T09:00:00.000Z"
}

Modificado em 2026-10-21 19:11:22

Página anterior

Informar pagamento ou inadimplência de uma CPR

Próxima página

Exportar CPRs da empresa (Excel)