curl --request GET 'https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
{ headers: { Authorization: `Bearer ${token}` } },
);
const secao = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
headers={"Authorization": f"Bearer {token}"},
)
secao = resposta.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": 2,
"protestsTotalValue": "R$ 5.850,33",
"protestsByRegion": [{ "name": "SP", "value": 2 }],
"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"
}
]
}
},
"integrationTypes": ["..."]
}
],
"errors": []
}
{
"code": 404,
"message": "Seção não encontrada"
}
Referência da API
Consultar Seção por Tipo
Retorna uma seção de um relatório pelo tipo, sem precisar do id da seção.
GET
/
report
/
{id}
/
section
/
{sectionType}
curl --request GET 'https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
{ headers: { Authorization: `Bearer ${token}` } },
);
const secao = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
headers={"Authorization": f"Bearer {token}"},
)
secao = resposta.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": 2,
"protestsTotalValue": "R$ 5.850,33",
"protestsByRegion": [{ "name": "SP", "value": 2 }],
"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"
}
]
}
},
"integrationTypes": ["..."]
}
],
"errors": []
}
{
"code": 404,
"message": "Seção não encontrada"
}
Quando usar
Use esta rota quando você tem o ID do relatório e quer um bloco específico (score, processos, balanço) sem carregar o relatório inteiro. OsectionType é a chave estável da seção: não muda entre ambientes nem entre relatórios.
Autenticação
Bearer JWT no headerAuthorization. Um relatório de outra organização responde 404.
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 abaixo. |
Tipos de seção
Quais seções existem num relatório depende do tipo de relatório, do documento (CPF ou CNPJ) e das fontes da política. A coluna Parecer IA marca as seções que recebem Parecer GYRA+ IA quando o parecer está habilitado no relatório. Análise e riscosectionType | Seção | Parecer IA |
|---|---|---|
SUMMARY | Resumo, indicadores consolidados de risco | não |
BASIC_INFORMATION | Informações básicas, dados cadastrais e QSA | sim |
LOCATION | Localização e fachada do endereço | sim |
RELATIONS | Vínculos societários e grupo econômico | sim |
SCORE | Score de bureau | sim |
POSITIVE_REGISTRY | Cadastro Positivo | sim |
PROCESSES | Processos judiciais | sim |
JUDGMENTS | Ações judiciais | sim |
CERTIFICATES | Certidões | sim |
LICENSES_AUTHORIZATIONS | Licenças e autorizações | sim |
PEP | Pessoa politicamente exposta | sim |
SANCTIONS | Sanções e listas restritivas | sim |
MEDIA_EXPOSURE | Exposição em mídia e reputação | sim |
CRIMINAL_RECORD | Antecedentes criminais e mandados de prisão (CPF) | sim |
SOCIAL_ASSISTANCE_PROGRAMS | Programas sociais e benefícios (CPF) | sim |
SECTOR | Panorama setorial e macroeconômico | sim |
sectionType | Seção | Parecer IA |
|---|---|---|
SCR | SCR, categorias e modalidades | sim |
SCR_SUMMARY | Resumo SCR, endividamento consolidado | sim |
SCR_INDICATORS | Indicadores do SCR | não |
PEFIN | Pefin | sim |
REFIN | Refin | sim |
PROTESTS | Protestos em cartório | sim |
BAD_CHECK | Cheques sem fundo | sim |
PAST_DUE_DEBT | Dívidas vencidas | sim |
PAYMENT_INTELLIGENCE | Inteligência de Pagamentos | não |
sectionType | Seção | Parecer IA |
|---|---|---|
BALANCE_SHEET | Balanço patrimonial | não |
DRE | Demonstração do resultado do exercício | não |
FINANCIAL_INDICATORS | Indicadores financeiros calculados | não |
FINANCIAL_INSIGHTS | Resumo executivo da análise financeira | não |
FINANCIAL_RECOMMENDATIONS | Recomendações da análise financeira | não |
BALANCE_SHEET_CHART | Séries do balanço para gráficos | não |
COST_PROFIT_FORECAST | Projeção de custo e resultado | não |
DETAILED_COSTS | Custos detalhados | não |
SUPPLIERS_CLIENTS | Fornecedores e clientes | não |
A leitura de IA do balanço não é um Parecer IA de seção: ela sai junto com a própria análise financeira, na seção
FINANCIAL_INSIGHTS. As seções financeiras passam a existir quando a GYRA+ encontra as demonstrações ou quando você as envia em Enviar Balanço e DRE.sectionType | Seção | Parecer IA |
|---|---|---|
CATEGORIES | Categorias de atividade | não |
HISTORY | Histórico cadastral | não |
DOMAINS | Domínios de internet associados | não |
BUREAU_INQUIRY | Consultas ao bureau | não |
CREDIT_POLICY | Resultado da avaliação da política de crédito | não |
PRICING | Limite, taxa e prazo calculados pela política | não |
INPUT_DATA | Dados de entrada da proposta | não |
Um
sectionType válido que não existe naquele relatório responde 404 com "Seção não encontrada", não vazio. Um valor que não é tipo de seção responde 404 com "Tipo de seção não encontrado". Para saber quais seções o relatório tem, leia sections[] em GET /v2/report/{id}.curl --request GET 'https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
{ headers: { Authorization: `Bearer ${token}` } },
);
const secao = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/6612a7f3a19b467000000000/section/PROTESTS",
headers={"Authorization": f"Bearer {token}"},
)
secao = resposta.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": 2,
"protestsTotalValue": "R$ 5.850,33",
"protestsByRegion": [{ "name": "SP", "value": 2 }],
"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"
}
]
}
},
"integrationTypes": ["..."]
}
],
"errors": []
}
{
"code": 404,
"message": "Seção não encontrada"
}
Erros
| Código | Mensagem | Causa |
|---|---|---|
404 | "Relatório não encontrado" | ID inexistente ou de outra organização. |
404 | "Tipo de seção não encontrado" | sectionType fora da lista acima. |
404 | "Seção não encontrada" | O relatório não tem essa seção. |
Path Parameters
Response
Secao com dados detalhados do tipo solicitado.
A secao pedida. Os campos de sectionDetails[].values mudam por tipo de secao; o dicionario esta em /data/estrutura-relatorio.

