Consultar Seção por Tipo

curl --location 'https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY' \
--header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY"
headers = {
  "Authorization": "Bearer abc123"
}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "6612a7f3dc5b830500000000",
  "report": {
    "id": "6612a7f3a19b467000000000",
    "organizationId": "6612a7f3fa9e086b00000000",
    "reportProgress": {
      "isFinalized": true,
      "finalizedAt": "2026-07-31T13:43:24.194Z"
    }
  },
  "type": {
    "id": "6612a7f3ae223a4700000000",
    "value": "PROTESTS",
    "tabs": [
      {
        "type": "RESTRICTIVE",
        "order": 5,
        "side": null
      }
    ]
  },
  "selectedIntegrations": [ "..." ],
  "createdAt": "2026-07-31T13:42:37.059Z",
  "updatedAt": "2026-07-31T13:43:12.180Z",
  "sectionDetails": [
    {
      "values": {
        "bureau": {
          "injunction": false,
          "protestsQuantity": 15,
          "protestsTotalValue": "R$ 102.390,05",
          "protestsByRegion": [
            {
              "name": "SP",
              "value": 5
            }
          ],
          "lastProtestDate": "2026-02-05T00:00:00.000Z",
          "formattedLastProtestDate": "05/02/2026",
          "protestsTable": [
            {
              "name": "-",
              "registry": "04",
              "formattedDate": "05/02/2026",
              "date": "2026-02-05T00:00:00.000Z",
              "uf": "SAO PAULO/SP",
              "value": 1679.95,
              "formattedValue": "R$ 1.679,95"
            },
            {
              "name": "-",
              "registry": "08",
              "formattedDate": "05/02/2026",
              "date": "2026-02-05T00:00:00.000Z",
              "uf": "SAO PAULO/SP",
              "value": 4170.38,
              "formattedValue": "R$ 4.170,38"
            }
          ]
        }
      },
      "integrationTypes": [ "..." ]
    }
  ],
  "errors": []
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Section not found"
}

Quando usar

Use este endpoint para buscar uma seção de um relatório usando o tipo (sectionType) em vez do sectionId. Útil em telas que renderizam abas por seção, carregam conteúdo sob demanda ou quando você só tem o ID do relatório e quer um bloco específico (ex.: score do bureau, processos judiciais).

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição
`id`	`path`	`string`	`sim`	ID do relatório.
`sectionType`	`path`	`string`	`sim`	Tipo da seção, em maiúsculas. Lista completa abaixo.

Tipos de seção

O sectionType é a chave estável da seção: não muda entre ambientes nem entre versões. Quais seções existem em um relatório específico depende do tipo de relatório, do documento (CPF ou CNPJ) e das fontes ativadas na política. Análise e risco

`sectionType`	Seção	Parecer IA
`SUMMARY`	Resumo, indicadores consolidados de risco	–
`BASIC_INFORMATION`	Informações básicas, dados cadastrais e QSA	✓
`LOCATION`	Localização e fachada do endereço	✓
`RELATIONS`	Vínculos societários e grupo econômico	✓
`SCORE`	Score de bureau	✓
`PROCESSES`	Processos judiciais	✓
`CERTIFICATES`	Certidões (federal, trabalhista, FGTS, estaduais)	✓
`LICENSES_AUTHORIZATIONS`	Licenças e autorizações	✓
`PEP`	Pessoa politicamente exposta	✓
`SANCTIONS`	Sanções e listas restritivas	✓
`MEDIA_EXPOSURE`	Exposição em mídia e reputação	✓
`CRIMINAL_RECORD`	Antecedentes criminais e mandados de prisão	✓
`SOCIAL_ASSISTANCE_PROGRAMS`	Programas sociais e benefícios	✓
`SECTOR`	Panorama setorial e macroeconômico	✓

Restritivos e endividamento

`sectionType`	Seção	Parecer IA
`SCR`	SCR / Open Finance, categorias e modalidades	✓
`SCR_SUMMARY`	Resumo SCR, endividamento consolidado	✓
`PEFIN`	Pefin, restritivos de credores não financeiros	✓
`REFIN`	Refin, restritivos de instituições financeiras	✓
`PROTESTS`	Protestos em cartório	✓
`BAD_CHECK`	Cheques sem fundo	✓
`PAST_DUE_DEBT`	Dívidas vencidas	✓
`PAYMENT_INTELLIGENCE`	Inteligência de pagamentos (fluxo transacionado)	–

Análise financeira (dependem do envio do balanço)

`sectionType`	Seção	Parecer IA
`BALANCE_SHEET`	Balanço patrimonial	✓
`DRE`	Demonstração do resultado do exercício	–
`FINANCIAL_INDICATORS`	Indicadores financeiros calculados	–
`FINANCIAL_INSIGHTS`	Resumo executivo da análise financeira	–
`FINANCIAL_RECOMMENDATIONS`	Recomendações da análise financeira	–
`BALANCE_SHEET_CHART`	Séries do balanço para gráficos	–
`COST_PROFIT_FORECAST`	Projeção de custo e resultado	–
`DETAILED_COSTS`	Custos detalhados	–
`SUPPLIERS_CLIENTS`	Fornecedores e clientes	–

Essas seções só existem depois que o balanço entra no relatório, seja porque a GYRA+ encontrou as demonstrações públicas, seja porque você as enviou via Enviar Balanço e DRE.

Complementares e resultado da política

`sectionType`	Seção	Parecer IA
`CATEGORIES`	Categorias de atividade	–
`HISTORY`	Histórico cadastral	–
`DOMAINS`	Domínios de internet associados	–
`BUREAU_INQUIRY`	Consultas ao bureau (histórico de pesquisas)	–
`CREDIT_POLICY`	Resultado da avaliação da política de crédito	–
`PRICING`	Limite, taxa e prazo calculados pela política	–

A coluna Parecer IA marca as 21 seções que recebem um Parecer GYRA+ IA nos relatórios COMPLETO e COMPLETO+. As demais são estruturais ou já derivadas de outra seção. Para ler só os pareceres, sem os dados brutos, use GET /report/{id}/insights.

Nem todo relatório tem todas as seções. CRIMINAL_RECORD e SOCIAL_ASSISTANCE_PROGRAMS só existem em relatórios de CPF; as seções de análise financeira só existem em CNPJ e só depois do envio do balanço. Um sectionType que não existe naquele relatório retorna 404, não vazio. Antes de consultar, confira o array sections[] em GET /v2/report/{id}.

curl --location 'https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY' \
--header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/69a207bcdd0197828df9155a/section/SUMMARY"
headers = {
  "Authorization": "Bearer abc123"
}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "6612a7f3dc5b830500000000",
  "report": {
    "id": "6612a7f3a19b467000000000",
    "organizationId": "6612a7f3fa9e086b00000000",
    "reportProgress": {
      "isFinalized": true,
      "finalizedAt": "2026-07-31T13:43:24.194Z"
    }
  },
  "type": {
    "id": "6612a7f3ae223a4700000000",
    "value": "PROTESTS",
    "tabs": [
      {
        "type": "RESTRICTIVE",
        "order": 5,
        "side": null
      }
    ]
  },
  "selectedIntegrations": [ "..." ],
  "createdAt": "2026-07-31T13:42:37.059Z",
  "updatedAt": "2026-07-31T13:43:12.180Z",
  "sectionDetails": [
    {
      "values": {
        "bureau": {
          "injunction": false,
          "protestsQuantity": 15,
          "protestsTotalValue": "R$ 102.390,05",
          "protestsByRegion": [
            {
              "name": "SP",
              "value": 5
            }
          ],
          "lastProtestDate": "2026-02-05T00:00:00.000Z",
          "formattedLastProtestDate": "05/02/2026",
          "protestsTable": [
            {
              "name": "-",
              "registry": "04",
              "formattedDate": "05/02/2026",
              "date": "2026-02-05T00:00:00.000Z",
              "uf": "SAO PAULO/SP",
              "value": 1679.95,
              "formattedValue": "R$ 1.679,95"
            },
            {
              "name": "-",
              "registry": "08",
              "formattedDate": "05/02/2026",
              "date": "2026-02-05T00:00:00.000Z",
              "uf": "SAO PAULO/SP",
              "value": 4170.38,
              "formattedValue": "R$ 4.170,38"
            }
          ]
        }
      },
      "integrationTypes": [ "..." ]
    }
  ],
  "errors": []
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Section not found"
}

Primeiros Passos

Conceitos Fundamentais

Guia do Toolbox

Fontes de Dados

Guias

Casos de Uso

MCP Server

Referência da API

Dicionário de Dados

Integrações

Referência

Consultar Seção por Tipo

Quando usar

Autenticação

Parâmetros

Tipos de seção

​Quando usar

​Autenticação

​Parâmetros

​Tipos de seção

Quando usar

Autenticação

Parâmetros

Tipos de seção