Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Esta página descreve a Política de Crédito, o conjunto de regras que controla decisões automáticas. A Política produz o Score durante a análise e usa as faixas de risco para chegar à Decisão Automática. Não confundir Política com Score: a Política é o conjunto de regras; o Score é o número final calculado por essas regras.

O que é uma Política de Crédito

Uma política de crédito é o conjunto de regras e critérios que define como a GYRA+ avalia um CPF ou CNPJ e chega a uma decisão automática. Ela responde a três perguntas:
  1. Quais dados consultar? → Define quais bureaus e integrações serão acionadas
  2. Quais critérios aplicar? → Define as regras de avaliação (score mínimo, limite de dívida, etc.)
  3. Qual a decisão? → Define quando aprovar, alertar ou negar
Toda chamada ao POST /report exige um policyId. Esse ID determina completamente o comportamento da análise.

Hierarquia de uma política

Policy
├── IntegrationGroup          → Fontes de dados consultadas (Bureau, SCR, Dados Cadasrais...)
├── PolicyRuleGroup[]         → Grupos de regras (ex: "Cadastral", "Financeiro")
│   ├── scoreApproved         → Pontuação mínima para aprovação no grupo
│   ├── scoreAlert            → Pontuação para alerta
│   ├── scoreDenied           → Pontuação para negação
│   └── PolicyRuleSettingJoin[]
│       ├── operationType     → Como as regras se combinam (sempre AND)
│       ├── statusToApply     → Resultado se a condição for verdadeira
│       └── PolicyRuleSetting → Regra configurada com seus parâmetros
└── Risk[]                    → Faixas de score final → status final
    └── { from, to, statusToApply }

Status possíveis de uma decisão

StatusCódigoDescrição
NOT_EXECUTED0Regra não foi avaliada
PENDING1Aguardando avaliação
APPROVED3Aprovado automaticamente
DENIED4Negado automaticamente
ALERT5Requer revisão manual
NOT_APPLIED8Regra não aplicável ao documento
Esse é o policyStatus retornado em todo relatório. Se ele deve ou não virar o status do relatório depende da configuração da política — veja Status do relatório × Status da política.

Decisão automática vs. análise manual

Cada política tem a opção “Usar resultado da política no relatório”:
  • Ligada: o resultado da política (policyStatus) é aplicado automaticamente ao status do relatório. Ideal para fluxos de alto volume (onboarding, checkout, crédito massificado).
  • Desligada: a política calcula o policyStatus como referência, mas o status do relatório fica PENDING até um analista decidir pela UI do Toolbox ou via POST /report/analyze. Ideal para mesa de crédito, due diligence e casos que exigem julgamento humano.
Mesmo com a opção ligada, a análise manual continua possível e sobrescreve o status do relatório, preservando o policyStatus original para auditoria.

Templates disponíveis

A GYRA+ oferece políticas prontas para os cenários mais comuns. Use o policyId correspondente ao chamar a API.
TemplatepolicyIdTipoRelatórioUso recomendado
Abertura de Conta67be2e43d6c1064a759601bfCPFEssencialKYC e onboarding de PF
Background Check679955e0485aa2f033203f98CNPJCompletoDue diligence de fornecedores
Financiamento LP67c07e841997d65ab3dc74cdCNPJCompletoCrédito para empresas
Você pode usar um template como ponto de partida e personalizar as regras, pesos e faixas de risco pelo painel do Toolbox ou pela API.

Como as regras são combinadas

Cada condição dentro de um grupo é formada por uma ou mais regras. As combinações possíveis são:
CombinaçãoComportamento
ANDAmbas as regras devem ser satisfeitas para gerar a ação (APPROVED, ALERT ou DENIED)
ORUma única regra satisfeita já gera a ação (APPROVED, ALERT ou DENIED)

Score da condição

O score é uma dimensão separada da combinação de regras. Para cada status final de uma condição há um valor que é somado ao score acumulado:
  • APPROVED → soma um valor positivo (ex.: +30 pts)
  • ALERT → soma um valor negativo leve (ex.: -50 pts)
  • DENIED → soma um valor negativo forte (ex.: -100 pts)
A política parte de 1000 pts e, após somar os deltas de todas as condições, gera o score final:
  • Faixa válida: 1 a 1000 pts
  • Se o total exceder 1000, mantém-se o limite superior 1000
  • Se ficar abaixo de 1, mantém-se o limite inferior 1
A faixa em que o score final cair determina o statusToApply configurado em Risk[].

Opções de uso

Você tem três formas de trabalhar com políticas:

Usar template pronto

Escolha um dos templates da GYRA+ e comece a analisar imediatamente. Ideal para quem está começando.

Personalizar template

Parta de um template existente e ajuste regras, pesos e critérios para a sua estratégia de risco.

Criar do zero

Configure uma política completamente nova com suas próprias variáveis, condições e faixas de decisão.
Para criar ou editar políticas pelo painel, acesse Políticas de Decisão no menu do Toolbox. Para gerenciar via API, veja a referência do endpoint de políticas.
Regra Tem mandato: disponível para uso em políticas de PF (relatórios COMPLETO e COMPLETO+). Avalia se o CPF possui mandado de prisão ativo no CNJ no mês corrente. Veja detalhes na seção CRIMINAL_RECORD.