Rodar a análise do motor de crédito para uma pessoa jurídica

Esse endpoint é responsável pela execução da análise do motor para uma pessoa jurídica.

Parâmetros da Requisição

• borrower_id (string/uuid v4, obrigatório): ID de identificação da empresa a ter a análise manual executada.

• product_id (string/uuid v4, obrigatório): ID de identificação do produto.

• funding_id (string/uuid v4, obrigatório): ID de identificação do Financiador desta operação (Cessionário, Credor).

• additional_information (object): Objeto contendo os dados adicionais para ser utilizados na execução do motor.

Resposta

A resposta para essa requisição é um status code "200 - Sucesso" e um JSON com o retorno da análise no seguinte formato:

• id (string/uuid v4): ID da análise executada.

• borrower -> id (string/uuid v4): ID de identificação da pessoa consultada.

• product -> id (string/uuid v4): ID de identificação do produto.

• bureau (object): Objeto contendo os dados da consulta externa realizada em um bureau.

• limits (object): Objeto contendo os parâmetros calculados para a política de crédito da Empresa.

• message (object): Objeto contendo a mensagem de retorno para a consulta realizada.

Objeto "bureau"

• external_sources (array): Objeto contendo uma lista dos tipos de consultas realizadas em cada passo no bureau.

• bureau_created_at (string/datetime): Data e hora das consultas realizadas no bureau.

Objeto "limits"

• created_at (string/datetime): Data de criação para o limite.

• expires_at (string/datetime): Data máxima para validade do limite.

• credit_min (string/float): Valor mínimo a ser disponibilizado no motor de crédito.

• credit_max (string/float): Valor máximo a ser disponibilizado no motor de crédito.

• currency (string): Tipo da moeda.

• document_number (string): Número do documento de identificação da Pessoa.

• document_type (string): Tipo do documento de identificação utilizado.

• estimated_revenue (string/float): Renda estimada informada da Pessoa para execução do cálculo.

• interest_rate (string/float): Taxa de juros a ser aplicada para as propostas.

• retention_rate_max (string/float): Taxa máxima a ser aplicada como retenção.

• min_retention (string/float): Taxa mínima a ser aplicada como retenção.

• retention_type (string): Tipo de retenção que será aplicadas nas propostas.

• term_min (string/int): Quantidade mínima de parcelas a ser retornada.

• term_max (string/int): Quantidade máxima de parcelas a ser retornada.

• min_payment_number (string/int): Quantidade mínima de parcelas a ser retornada.

• max_payment_number (string/int): Quantidade máxima de parcelas a ser retornada.

• periodicity (string): Periodicidade a ser utilizada no cálculo das propostas.

• min_grace_period (string/int): Período mínimo de carência a ser aplicado nas propostas.

• max_grace_periodo (string/int): Período máximo de carência a ser aplicado nas propostas.

Objeto "message"

• code (string): Código de identificação de status do limite.

• detail (string): Descrição referente ao status do limite.

• display (string): Mensagem tratatada para exibição do status do limite .

• status (string): Status de retorno do limite.

• politic_name (string): Nome da política que foi executada

• product_id (string/uuid v4): ID de identificação do produto.

• product_name (string): Nome de cadastro do produto.

{
  "id": "<uuid>",
  "product": {
    "id": "<uuid>"
  },
  "borrower": {
    "id": "<uuid>"
  },
  "bureau": {
    "mollite": "<string>"
  },
  "limits": {
    "term_max": "<number>",
    "term_min": "<number>",
    "currency": "<string>",
    "created_at": "<string>",
    "credit_max": "<double>",
    "credit_min": "<double>",
    "expires_at": "<string>",
    "periodicity": "<string>",
    "document_type": "<string>",
    "interest_rate": "<number>",
    "min_retention": "<double>",
    "document_number": "<string>",
    "max_grace_period": "<long>",
    "min_grace_period": "<long>",
    "estimated_revenue": "<double>",
    "max_payment_number": "<long>",
    "min_payment_number": "<long>",
    "retention_rate_max": "<double>",
    "retention_type": "<string>"
  },
  "message": "<string>"
}