curl --request GET 'https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
{ headers: { Authorization: `Bearer ${token}` } },
);
const relatorio = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
)
relatorio = resposta.json()
{
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:43:28.150Z",
"document": "11222333000181",
"yearMonthDay": 20260731,
"policyId": "6612a7f3625ea4ab00000000",
"policyVersion": 3,
"policyName": "Completo+",
"organizationId": "6612a7f3fa9e086b00000000",
"commentary": null,
"previousAnalystId": null,
"policyErrorStatusApplied": null,
"userId": "6612a7f338154f0100000000",
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
},
"reportProgress": {
"isFinalized": true,
"finalizedAt": "2026-07-31T13:43:24.194Z",
"steps": []
},
"analystId": null,
"analystName": null,
"ranWithoutSCRReason": null,
"sections": [
{
"id": "6612a7f30a2c8b1a00000000",
"type": {
"id": "6612a7f3cd81d4f900000000",
"title": "Sanções",
"value": "SANCTIONS"
},
"comments": [],
"sectionDetails": [
{ "values": { "...": "dados da seção" }, "errors": [] }
],
"parecer": "Texto do parecer da seção...",
"parecerScore": 10,
"parecerRiskLevel": "LOW",
"parecerStatus": "DONE",
"parecerFeedback": null,
"errors": []
}
],
"product": null,
"verified": true,
"exportUrl": null,
"exportExcelUrl": null,
"parecerEnabled": true,
"committeeStatus": null,
"committeeDecision": null,
"committeeResult": null
}
{
"code": 404,
"message": "Relatório não encontrado"
}
Referência da API
Consultar Relatório (v2)
Retorna o relatório completo, com status, progresso, seções, pareceres e resultado do comitê.
GET
/
v2
/
report
/
{id}
curl --request GET 'https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
{ headers: { Authorization: `Bearer ${token}` } },
);
const relatorio = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
)
relatorio = resposta.json()
{
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:43:28.150Z",
"document": "11222333000181",
"yearMonthDay": 20260731,
"policyId": "6612a7f3625ea4ab00000000",
"policyVersion": 3,
"policyName": "Completo+",
"organizationId": "6612a7f3fa9e086b00000000",
"commentary": null,
"previousAnalystId": null,
"policyErrorStatusApplied": null,
"userId": "6612a7f338154f0100000000",
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
},
"reportProgress": {
"isFinalized": true,
"finalizedAt": "2026-07-31T13:43:24.194Z",
"steps": []
},
"analystId": null,
"analystName": null,
"ranWithoutSCRReason": null,
"sections": [
{
"id": "6612a7f30a2c8b1a00000000",
"type": {
"id": "6612a7f3cd81d4f900000000",
"title": "Sanções",
"value": "SANCTIONS"
},
"comments": [],
"sectionDetails": [
{ "values": { "...": "dados da seção" }, "errors": [] }
],
"parecer": "Texto do parecer da seção...",
"parecerScore": 10,
"parecerRiskLevel": "LOW",
"parecerStatus": "DONE",
"parecerFeedback": null,
"errors": []
}
],
"product": null,
"verified": true,
"exportUrl": null,
"exportExcelUrl": null,
"parecerEnabled": true,
"committeeStatus": null,
"committeeDecision": null,
"committeeResult": null
}
{
"code": 404,
"message": "Relatório não encontrado"
}
Quando usar
Use esta rota para ler o resultado de um relatório criado emPOST /v2/report: status da decisão, progresso do processamento e o conteúdo de todas as seções. Para ler uma seção só, use Consultar Seção por Tipo. Para ler só os pareceres, use GET /report/{id}/insights.
Autenticação
Bearer JWT no headerAuthorization. A credencial precisa da permissão de leitura de relatórios pela API. Um id de outra organização responde 404.
Parâmetros
| Nome | Local | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
id | path | string | sim | ID do relatório devolvido em POST /v2/report. |
Resposta
| Campo | Descrição |
|---|---|
status.value | Decisão do relatório: PENDING, APPROVED ou REJECTED. |
reportProgress.isFinalized | true quando todas as fontes terminaram. finalizedAt traz a data. |
sections[] | Uma entrada por seção: id, type (id, title, value), sectionDetails[] (values e errors), errors, o comentário mais recente em comments[] e os campos do Parecer IA (parecer, parecerScore, parecerRiskLevel, parecerStatus, parecerFeedback). |
policyId, policyName, policyVersion | Política aplicada. |
analystId, analystName, commentary | Decisão manual, quando houver. |
parecerEnabled | Se o relatório gera Parecer IA por seção. |
committeeStatus, committeeDecision, committeeResult | Resultado do Comitê de Crédito IA, quando convocado. |
exportUrl, exportExcelUrl | Último arquivo exportado (PDF e Excel), ou null. |
curl --request GET 'https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000' \
--header 'Authorization: Bearer SEU_TOKEN'
const resposta = await fetch(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
{ headers: { Authorization: `Bearer ${token}` } },
);
const relatorio = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v2/report/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
)
relatorio = resposta.json()
{
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:43:28.150Z",
"document": "11222333000181",
"yearMonthDay": 20260731,
"policyId": "6612a7f3625ea4ab00000000",
"policyVersion": 3,
"policyName": "Completo+",
"organizationId": "6612a7f3fa9e086b00000000",
"commentary": null,
"previousAnalystId": null,
"policyErrorStatusApplied": null,
"userId": "6612a7f338154f0100000000",
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
},
"reportProgress": {
"isFinalized": true,
"finalizedAt": "2026-07-31T13:43:24.194Z",
"steps": []
},
"analystId": null,
"analystName": null,
"ranWithoutSCRReason": null,
"sections": [
{
"id": "6612a7f30a2c8b1a00000000",
"type": {
"id": "6612a7f3cd81d4f900000000",
"title": "Sanções",
"value": "SANCTIONS"
},
"comments": [],
"sectionDetails": [
{ "values": { "...": "dados da seção" }, "errors": [] }
],
"parecer": "Texto do parecer da seção...",
"parecerScore": 10,
"parecerRiskLevel": "LOW",
"parecerStatus": "DONE",
"parecerFeedback": null,
"errors": []
}
],
"product": null,
"verified": true,
"exportUrl": null,
"exportExcelUrl": null,
"parecerEnabled": true,
"committeeStatus": null,
"committeeDecision": null,
"committeeResult": null
}
{
"code": 404,
"message": "Relatório não encontrado"
}
O exemplo mostra uma seção. Um relatório real traz todas as seções da política, e
sectionDetails[].values muda de forma por tipo de seção. O dicionário está em Estrutura do relatório.
