curl --location 'https://gyra-core.gyramais.com.br/report/section/665f1498530134f172352f03' \
--header 'Authorization: Bearer abc123'
fetch("https://gyra-core.gyramais.com.br/report/section/665f1498530134f172352f03", {
method: "GET",
headers: {
Authorization: "Bearer abc123"
}
})
.then(res => res.json())
.then(console.log)
import requests
url = "https://gyra-core.gyramais.com.br/report/section/665f1498530134f172352f03"
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": 501,
"message": "Inconsistent column data: Malformed ObjectID"
}
Quando usar
Use este endpoint para consultar uma seção específica já identificada dentro de um relatório. Você pode usar quando a experiência do cliente ou do analista precisa abrir apenas um bloco do relatório (ex.: financeiro, restrições, score) sem recarregar tudo.Autenticação
Bearer JWT no headerAuthorization.
Parâmetros
| Nome | Local | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
id | path | string | sim | Identificador da seção do relatório |
Como obter o id
O
id desta rota é o id da seção dentro de um relatório específico. Ele é gerado por relatório: a mesma seção PROCESSES tem um id diferente em cada análise. Não existe uma lista fixa de ids que você possa guardar.sections[] do relatório:
curl 'https://gyra-core.gyramais.com.br/v2/report/{reportId}' \
-H 'Authorization: Bearer {seu_token_jwt}'
{
"id": "69a207bcdd0197828df9155a",
"sections": [
{ "id": "69a207bcdd0197828df9156a", "type": { "id": "672b49a91acad6953b56b109", "value": "SUMMARY" } },
{ "id": "69a207bcdd0197828df9156b", "type": { "id": "672b49a91acad6953b56b110", "value": "PROCESSES" } }
]
}
| Campo | O que é | Estabilidade |
|---|---|---|
id (da seção) | A seção daquele relatório. É o que vai nesta rota. | Único por relatório |
type.id | O registro do tipo de seção no catálogo interno | Varia por ambiente, não use como chave |
type.value | O nome do tipo (SUMMARY, PROCESSES, …) | Estável. É a chave a guardar no seu lado |
Se você já sabe qual seção quer e só tem o
reportId, pule esta rota: GET /report/{id}/section/{sectionType} busca direto pelo tipo, sem precisar descobrir o id antes. É uma requisição em vez de duas.Tipos de seção (type.value)
| Grupo | sectionType |
|---|---|
| Análise e risco | SUMMARY, BASIC_INFORMATION, LOCATION, RELATIONS, SCORE, PROCESSES, CERTIFICATES, LICENSES_AUTHORIZATIONS, PEP, SANCTIONS, MEDIA_EXPOSURE, CRIMINAL_RECORD, SOCIAL_ASSISTANCE_PROGRAMS, SECTOR |
| Restritivos e endividamento | SCR, SCR_SUMMARY, PEFIN, REFIN, PROTESTS, BAD_CHECK, PAST_DUE_DEBT, PAYMENT_INTELLIGENCE |
| Análise financeira | BALANCE_SHEET, DRE, FINANCIAL_INDICATORS, FINANCIAL_INSIGHTS, FINANCIAL_RECOMMENDATIONS, BALANCE_SHEET_CHART, COST_PROFIT_FORECAST, DETAILED_COSTS, SUPPLIERS_CLIENTS |
| Complementares e política | CATEGORIES, HISTORY, DOMAINS, BUREAU_INQUIRY, CREDIT_POLICY, PRICING |