Solicitar análise de endividamento por IA

POST

/v2/queries/clients/{clientId}/scr-ia-analysis/{scrId}

Solicita a análise por IA do endividamento (SCR) já consultado do cliente, debitando o saldo da empresa e registrando o faturamento. Informe em scrId o identificador do resultado de SCR, devolvido no campo _id da consulta de endividamento do cliente. A análise nasce com status FILA e o processamento é assíncrono: o resultado aparece depois no campo scrAnalysis da consulta de endividamento do cliente. Se a solicitação falhar, o débito do saldo e o faturamento são desfeitos. Nesta rota, os erros de negócio (SCR não encontrado, saldo insuficiente, empresa bloqueada, cliente ou usuário não encontrados, produto indisponível) devolvem 400, e o corpo de erro traz apenas message, sem statusCode. 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

Respostas

🟢200Análise solicitada

application/json

Análise solicitada

Bodyapplication/json

🟠400Falha ao solicitar

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🔴500Erro interno

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/queries/clients/4005e4a6-08b5-4dea-b4f9-35a6630154ad/scr-ia-analysis/9b2f4c1e-5a7d-4e8b-9c3f-2d1a6b8e7f40' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "message": "Solicitação de Análise de Endividamento por IA registrada com sucesso."
}

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

Página anterior

Visualizar resumo do SCR de um cliente

Próxima página

Visualizar compliance de um cliente