Insights

Funcionamento do Módulo Insights

O módulo Insights opera de forma síncrona, realizando a análise dos dados imediatamente após o recebimento de uma solicitação. Esse processo envolve o cruzamento de múltiplas informações relevantes, com o objetivo de calcular o score, determinar o status e os insights da análise.

A resposta da análise é retornada em questão de segundos, permitindo decisões rápidas e integradas ao fluxo da aplicação, sem a necessidade de processamento assíncrono ou espera prolongada.

POST Response

Representa a resposta de execução da integração no módulo Insights. Caso tenha contratado mais de um módulo, pode receber todos de uma vez. O que não tiver contratado, não será retornado.

Result

Insights Result

Representa os insights gerados pela análise.

Insight

Representa um insight gerado pela análise.

JSON

{
  "executionId": "string",
  "analysisId": "string",
  "transactionId": "string",
  "insights": {
    "status": "string",
    "result": [
      {
        "code": "string",
        "description": "string",
        "type": "string",
        "category": "string",
        "relevance": "string",
        "relatedTo": [
          "string"
        ]
      }
    ]
  }
}

GET Response

Representa a resposta de execução da consulta da análise.

Result

Insights Result

Representa os insights gerados pela análise.

Insight

Representa um insight gerado pela análise.

JSON

{
  "analysisId": "string",
  "transactionId": "string",
  "insights": {
    "status": "string",
    "result": [
      {
        "code": "string",
        "description": "string",
        "type": "string",
        "category": "string",
        "relevance": "string",
        "relatedTo": [
          "string"
        ]
      }
    ]
  }
}

Response com erro

Representa os detalhes de um problema retornado pela API em caso de erro.

JSON

{
  "errors": {
    "string": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "traceId": "string"
}