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:- Quais dados consultar? → Define quais bureaus e integrações serão acionadas
- Quais critérios aplicar? → Define as regras de avaliação (score mínimo, limite de dívida, etc.)
- Qual a decisão? → Define quando aprovar, alertar ou negar
POST /report exige um policyId. Esse ID determina completamente o comportamento da análise.
Hierarquia de uma política
Status possíveis de uma decisão
| Status | Código | Descrição |
|---|---|---|
NOT_EXECUTED | 0 | Regra não foi avaliada |
PENDING | 1 | Aguardando avaliação |
APPROVED | 3 | Aprovado automaticamente |
DENIED | 4 | Negado automaticamente |
ALERT | 5 | Requer revisão manual |
NOT_APPLIED | 8 | Regra não aplicável ao documento |
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 aostatusdo relatório. Ideal para fluxos de alto volume (onboarding, checkout, crédito massificado). - Desligada: a política calcula o
policyStatuscomo referência, mas ostatusdo relatório ficaPENDINGaté um analista decidir pela UI do Toolbox ou viaPOST /report/analyze. Ideal para mesa de crédito, due diligence e casos que exigem julgamento humano.
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 opolicyId correspondente ao chamar a API.
| Template | policyId | Tipo | Relatório | Uso recomendado |
|---|---|---|---|---|
| Abertura de Conta | 67be2e43d6c1064a759601bf | CPF | Essencial | KYC e onboarding de PF |
| Background Check | 679955e0485aa2f033203f98 | CNPJ | Completo | Due diligence de fornecedores |
| Financiamento LP | 67c07e841997d65ab3dc74cd | CNPJ | Completo | Crédito para empresas |
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ção | Comportamento |
|---|---|
AND | Ambas as regras devem ser satisfeitas para gerar a ação (APPROVED, ALERT ou DENIED) |
OR | Uma ú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)
- Faixa válida: 1 a 1000 pts
- Se o total exceder
1000, mantém-se o limite superior1000 - Se ficar abaixo de
1, mantém-se o limite inferior1
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.
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.
