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.

Filtros disponíveis

Você pode utilizar query parameters para filtrar os relatórios retornados por este endpoint.

Parâmetros suportados

ParâmetroTipoDescrição
takenumberLimita o número de relatórios retornados (ex: take=10)
skipnumberIgnora os primeiros N resultados (ex: skip=5)
statusValuestringFiltra por status do relatório: approved, rejected, pending
documentstringCPF ou CNPJ do cliente associado ao relatório (somente números)

Exemplo de requisição com filtros

GET /report/list?take=2&document=24657266000170
Este exemplo retorna os 2 relatórios mais recentes relacionados ao documento 24657266000170.
Você pode combinar múltiplos filtros conforme necessário.
curl --location 'https://gyra-core.gyramais.com.br/report/list?take=2&document=24657266000170' \
--header 'Authorization: Bearer {seu_token_jwt}'
O exemplo de resposta foi resumido para facilitar a leitura. O JSON completo está disponível no ambiente real ou mediante solicitação técnica.
[
  {
    "id": "69a207bcdd0197828df9155a",
    "policyId": "69a1fbb06a44799c9c440d2d",
    "policyStatus": "DENIED",
    "name": "CLIENTE EXEMPLO",
    "document": "43**********30",
    "createdAt": "2026-02-27T21:08:11.938Z",
    "status": {
      "value": "PENDING",
      "title": "Não iniciado"
    }
  }
]

Quando usar

Use este endpoint para recuperar histórico de análises com filtros operacionais. Você pode usar em telas de acompanhamento, filas de trabalho de analistas ou consultas por documento/status/período para operação diária.

Autenticação

Bearer JWT no header Authorization.