Motor de Decisão - 🧪 Beta#

O Motor de Decisão automatiza a avaliação de risco jurídico de pessoas físicas e jurídicas. Ele aplica regras configuradas conforme o caso de uso (crédito, onboarding, compliance) e retorna um nível de criticidade calculado conforme configuração do seu motor.

Como funciona o Motor de Decisão#

Você define, junto com o time Jusbrasil, os critérios de risco (ex.: fluxo_onboarding, fluxo_credito, fluxo_pld e etc).
Isso gera um criteria_slug.
Para cada CPF/CNPJ, você chama POST /background-check/assessments com document_number + criteria_slug.
O Motor retorna a criticidade calculada.
Se precisar entender por que deu aquele resultado, use GET /background-check/assessments/{id}/audit para ver processos, regras e justificativas.

Conceitos importantes:

Critério de risco (criteria_slug) – conjunto de regras configurado para um caso de uso (ex.: onboarding, crédito, fraude). Definido com o nosso time de legal experts.
Avaliação – resultado da aplicação de um critério de risco a um documento CPF/CNPJ.
Criticidade – maior nível de risco retornado da consulta do documento.
Justificativa – item que explica por que aquela criticidade foi atribuída ao documento consultado.

O processamento é síncrono: a criticidade é calculada na mesma requisição, SLA médio < 1s.

Criar avaliação de decisão#

Cria a consulta de avaliação para determinado CPF/CNPJ aplicando os critérios definidos pelo cliente por cada criteria_slug. Retorna 201 (Created) com o corpo da avaliação e o header Location apontando para o recurso criado.

cURL

curl -X POST 'https://api.jusbrasil.com.br/background-check/assessments' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>' \
  -d '{
    "document_number": "72833664826",
    "criteria_slug": "fluxo_onboarding",
    "external_id": "external_id" // * CAMPO OPCIONAL *
  }'

Nota

Recomendamos enviar o header X-Request-ID (UUID v4) para facilitar rastreamento e suporte.

Resposta

HTTP/1.1 201 Created
Content-Type: application/json
Location: /background-check/assessments/5a33677d-fd64-4f9d-a8af-3c3aed77c95f

{
  "data": {
    "id_avaliacao": "5a33677d-fd64-4f9d-a8af-3c3aed77c95f",
    "id_externo": "external_id",
    "criticidade": "1",
    "slug_criterios": "fluxo_onboarding",
    "data_criacao": "2024-06-20T12:34:56Z"
  },
  "_meta": {
    "versao_criterios": "v1",
    "identificacao": {
      "numero_documento": "72833664826",
      "tipo_documento": "CPF"
    }
  }
}

Consultar avaliação por ID#

Obtém uma avaliação existente a partir do id_avaliacao. Retorna 200 (OK) com os dados calculados (criticidade) e metadados de identificação.

cURL

curl -X GET 'https://api.jusbrasil.com.br/background-check/assessments/5a33677d-fd64-4f9d-a8af-3c3aed77c95f' \
  -H 'Accept: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id_avaliacao": "5a33677d-fd64-4f9d-a8af-3c3aed77c95f",
    "id_externo": "external_id",
    "criticidade": "6",
    "slug_criterios": "fluxo_onboarding",
    "data_criacao": "2024-06-20T12:34:56Z"
  },
  "_meta": {
    "versao_criterios": "v1",
    "identificacao": {
      "numero_documento": "72833664826",
      "tipo_documento": "CPF"
    }
  }
}

Listar justificativas e processos de uma avaliação#

Retorna os detalhes da auditoria de uma avaliação, incluindo os processos, regras e justificativas aplicados no cálculo da criticidade para o conjunto de critérios informado.

Este endpoint permite acompanhar como suas regras foram aplicadas e contribuíram para o resultado final, exibindo as justificativas e as quantidades de ocorrências identificadas.

cURL

curl -X GET 'https://api.jusbrasil.com.br/background-check/assessments/5a33677d-fd64-4f9d-a8af-3c3aed77c95f/audit' \
  -H 'Accept: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id_avaliacao": "019a4eb3-9e4b-74fc-95aa-f482500f2d36",
    "criticidade": "6" // o risco calculado para o conjunto de critérios aplicados,
    "slug_criterios": "fluxo_onboarding",
    "justificativas": [
        {
          "id_justificativa": "019a4b10-fbac-752e-b39b-2ff085f75583",
          "tipo": "processo",
          "item": {
              "numero": "0079466-67.2025.8.19.0000",
              "tipo_processo": "CRIMINAL",
              "ano_processo": 2025,
              "assunto": "Direito Penal - Homicídio Qualificado - Crimes contra a vida",
              "link": "https://www.jusbrasil.com.br/consulta-pro/processos/0079466-67.2025.8.19.0000"
          },
          "data_criacao": "2025-11-03T18:53:15.56432525Z"
        },
        {
          "id_justificativa": "0278a1c1-9ca9-4d36-9636-aae1e9c22d16",
          "tipo": "processo",
          "item": {
              "numero": "0279329-59.2024.8.19.0003",
              "tipo_processo": "CIVIL",
              "ano_processo": 2024,
              "assunto": "Cláusulas Abusivas - DIREITO DO CONSUMIDOR",
              "link": "https://www.jusbrasil.com.br/consulta-pro/processos/0279329-59.2024.8.19.0003"
          },
          "data_criacao": "2025-11-03T18:53:15.56432525Z"
        },
        {
          "id_justificativa": "ca51757c-32a8-4ae5-8024-7bf4d16647e3",
          "tipo": "processo",
          "item": {
              "numero": "0004669-57.2024.8.19.0203",
              "tipo_processo": "CIVIL",
              "ano_processo": 2024,
              "assunto": "Tutela de Urgência - Tutela Provisória - DIREITO PROCESSUAL CIVIL E DO TRABALHO",
              "link": "https://www.jusbrasil.com.br/consulta-pro/processos/0004669-57.2024.8.19.0203"
          },
          "data_criacao": "2025-11-03T18:53:15.56432525Z"
        },
    ],
    "data_criacao": "2025-11-04T11:49:45.675322027Z"
  },
  "_meta": {
    "total": 3,
    "limite": 20,
    "cursor": "eyJsaW1pdCI6MjAsImxhc3RfaWRfdmFsdWUiOiJjYTUxNzU3Yy0zMmE4LTRhZTUtODAyNC03YmY0ZDE2NjQ3ZTMiLCJsYXN0X3NvcnRfdmFsdWUiOiIyMDI1LTExLTA0VDExOjQ5OjQ1LjY3NTMyMjAyN1oifQ==",
    "identificacao": {
      "numero_documento": "72833664826",
      "tipo_documento": "CPF"
    }
  }
}

Parâmetros de Resposta#

**Resposta**#
Parâmetro	Tipo	Descrição
id_avaliacao	String	Identificador da avaliação (UUID v4)
id_externo	String/null	Identificador externo enviado pelo cliente
criticidade	String/null	Nível de criticidade resultante conforme os critérios configurados.
slug_criterios	String	Slug dos critérios aplicados
data_criacao	String	Data de criação no formato ISO 8601
justificativas	Lista	Lista de justificativas para a criticidade.
justificativas.id_justificativa	String	ID da justificativa.
justificativas.tipo	String	Tipo de item (ex: “processo”).
justificativas.item	Objeto	Detalhes do item que gerou a justificativa.
justificativas.item.numero	String	Número do processo.
justificativas.item.tipo_processo	String	Tipo do processo (ex: “CRIMINAL”, “CIVIL”).
justificativas.item.ano_processo	Integer	Ano do processo.
justificativas.item.assunto	String	Assunto do processo.
justificativas.item.link	String	Link para a página do processo no Jusbrasil.
justificativas.data_criacao	String	Data de criação da justificativa (ISO 8601).