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.

Acompanhe as novidades, melhorias e correções da plataforma GYRA+ Toolbox.

​
Abril 2026

​
CNJ — Mandados de Prisão em Antecedente Criminal

Novidades
  • Nova fonte CNJ (mandados de prisão) integrada à seção CRIMINAL_RECORD. Disponível apenas para PF nos relatórios COMPLETO e COMPLETO+. Frequência de atualização: mensal.
  • Indicação visual na UI (dentro de Antecedente Criminal):
    • Situação X (vermelho): mandado de prisão ativo encontrado no mês.
    • Situação ! (amarelo): já existiu mandado no passado, mas não há mandado ativo no mês atual.
  • Nova regra Tem mandato disponível nas políticas de crédito.
  • A seção Antecedentes criminais passa a ser exibida no PDF do relatório (antes não constava).

​
Março 2025

​
API v2.3, Templates de Políticas e Melhoria no Webhook

Novidades
  • Três novos templates de política disponíveis: Abertura de Conta, Background Check e Financiamento LP
  • Webhook agora inclui o campo score no payload, além de policyStatus
  • Novo campo externalId aceito no POST /report e devolvido no webhook
Melhorias
  • Tempo médio de processamento do relatório COMPLETO+ reduzido em 30%
  • Seção SANCTIONS agora inclui listas OFAC, CNEP e CEPIM
  • Melhoria na normalização dos dados SCR para empresas com histórico acima de 5 anos
Correções
  • Corrigido: seção PROCESSES retornando vazia em alguns casos de CNPJ MEI
  • Corrigido: calculatedRevenuePercentage retornando null quando faturamento não disponível no bureau

​
Fevereiro 2025

​
API v2.2, SCR com Histórico Ampliado

Novidades
  • Histórico SCR ampliado de 12 para 60 meses (5 anos) no relatório COMPLETO+
  • Nova seção CATEGORIES com breakdown do endividamento bancário por modalidade
  • Endpoint GET /report/list agora suporta filtro por policyStatus
Melhorias
  • Seção BASIC_INFORMATION agora inclui taxRegime (regime tributário)
  • Certidões (COMPLETO+) com tempo médio reduzido em 40%
  • Adicionado campo riskBand no resultado da CREDIT_POLICY

​
Janeiro 2025

​
API v2.1, Processos com Cobertura Estendida

Novidades
  • Relatório COMPLETO+ agora cobre processos desde 1980 (anteriormente 2005)
  • Novo campo ownersLawsuits na seção SUMMARY com processos dos sócios consolidados
  • Webhook com retry automático: até 3 tentativas em caso de falha no seu endpoint
Melhorias
  • Melhoria na detecção de COMPLETE_QSA_CHANGE, agora detecta trocas parciais significativas (> 70%)
  • Seção PEP com histórico de doações eleitorais desde 2010
  • Resposta da autenticação agora inclui expiresIn (TTL do token em segundos)

​
Dezembro 2024

​
API v2.0, Motor de Políticas Customizáveis

Novidades
  • Motor de políticas de crédito completamente reescrito: suporte a grupos de regras, scores por grupo e Risk Bands configuráveis
  • Novos operadores: BETWEEN, CONTAINS, NOT_CONTAINS, IS_TRUE, IS_FALSE
  • Regras financeiras proporcionais ao faturamento: PEFIN_CALCULATED_REVENUE, LAWSUITS_CALCULATED_REVENUE, SCR_CALCULATED_REVENUE_EXPIRED
  • Suporte a análise de sócios nas regras: OWNER_LAWSUITS_HAS_CRIMINAL, BUSINESS_PARTNERS_RESTRICTIVE
Breaking changes v2.0
  • O campo result no retorno do relatório foi renomeado para policyStatus
  • A estrutura do CREDIT_POLICY nos details foi reformulada para incluir grupos e scores
  • Webhooks v1 deixarão de ser suportados em março de 2025
Se você ainda usa a API v1 (endpoints sem /v2/), migre para a v2 antes de março de 2025. Consulte o Guia de Migração para detalhes.

​
Novembro 2024

​
API v1.5, Novo Bureau Complementar e Score PJ

Novidades
  • Integração com Bureau de Crédito Complementar como fonte de score alternativa
  • Score sintético especializado em PJ, disponibilizado pelo Bureau de Crédito Principal
  • Novo tipo de relatório COMPLETO+ com certidões em tempo real
  • Campo integrationCount por seção indicando quantas fontes contribuíram para os dados

​
Outubro 2024

​
API v1.4, Webhooks

Novidades
  • Lançamento dos webhooks, receba a decisão assim que o relatório for concluído
  • Endpoints: POST /webhook, GET /webhook/findby, DELETE /webhook/:id
  • Payload do webhook inclui: reportId, document, type, status, policyStatus
Para versões anteriores ao v1.4, entre em contato com atendimento@gyramais.com.