Skip to main content

​
Visão geral

Um relatório é o produto principal da GYRA+. Ele reúne, em um único objeto estruturado, todas as informações relevantes para a análise de crédito de uma pessoa física (CPF) ou jurídica (CNPJ). Cada relatório é gerado a partir de um CPF ou CNPJ combinado com uma Política de Crédito. A política determina quais fontes serão consultadas, quais regras serão aplicadas e qual a decisão final.

​
Ciclo de vida de um relatório

StatusDescrição
PENDINGRelatório criado, consultas em andamento
APPROVEDPolítica avaliada, resultado: aprovado
DENIEDPolítica avaliada, resultado: negado
ALERTPolítica avaliada, requer revisão manual
O processamento é assíncrono. Após o POST /report, você recebe o resultado via webhook ou consulta com GET /report/:id.

​
Tipos de relatório

A GYRA+ oferece quatro profundidades de análise, identificadas como tipos de relatório. Cada tipo está vinculado à política de crédito utilizada.
TipoCoberturaIndicado para
SIMPLESDados cadastrais + localizaçãoQualificação de leads, higienização de base
ESSENCIALCadastral + score + relacionamentos + restrições básicasCrédito de ticket baixo, onboarding rápido
COMPLETOEssencial + SCR Bacen + processos desde 2014Crédito B2B, análise de risco médio
COMPLETO+Completo + certidões em tempo real + processos desde 1995Grandes operações, due diligence, risco alto

Comparativo completo dos relatórios

Acesse o comparativo detalhado com todos os campos disponíveis em cada tipo.

​
Estrutura de um relatório

Um relatório é composto por seções. Cada seção corresponde a um tema de análise (processos judiciais, protestos, score, etc.) e é gerada de forma independente pelas integrações ativas na política. 
Report
├── id, document, status, createdAt
├── type (SIMPLES / ESSENCIAL / COMPLETO / COMPLETO+)
├── commentary (análise gerada por IA)
├── policyResult (decisão automática + regras avaliadas)
└── sections[]
    ├── BASIC_INFORMATION
    ├── SUMMARY
    ├── RELATIONS
    ├── PROCESSES
    ├── PROTESTS
    ├── PEFIN / REFIN
    ├── HISTORY / CATEGORIES (SCR)
    ├── PEP / SANCTIONS
    ├── CERTIFICATES
    └── CREDIT_POLICY
Veja a documentação completa de cada seção no Dicionário de Dados.

​
Como acessar um relatório

curl -X POST https://gyra-core.gyramais.com.br/report \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "43591367000130",
    "policyId": "67be2e43d6c1064a759601bf",
    "type": "CNPJ"
  }'
Configure um webhook para receber a decisão assim que o relatório for concluído, sem precisar fazer polling.