Skip to main content
POST
/
report
curl --location 'https://gyra-core.gyramais.com.br/report' \
--header 'Authorization: Bearer abc123' \
--header 'Content-Type: application/json' \
--data-raw '{
  "document": "12345678901",
  "type": "cpf",
  "policyId": "abc123"
}'

{
  "id": "69a207bcdd0197828df9155a",
  "policyId": "69a1fbb06a44799c9c440d2d",
  "document": "43591367000130",
  "policyStatus": "DENIED",
  "status": {
    "id": "6614758260513064a5af1046",
    "value": "PENDING",
    "title": "Não iniciado"
  },
  "createdAt": "2026-02-27T21:08:11.938Z",
  "updatedAt": "2026-02-27T21:08:11.938Z"
}

curl --location 'https://gyra-core.gyramais.com.br/report' \
--header 'Authorization: Bearer abc123' \
--header 'Content-Type: application/json' \
--data-raw '{
  "document": "12345678901",
  "type": "cpf",
  "policyId": "abc123"
}'
A requisição retorna o id e status do relatório. Você pode configurar para receber atualizações em real time na sessão webhooks ou consultar o id na api Get Report para um status atualizado
{
  "id": "69a207bcdd0197828df9155a",
  "policyId": "69a1fbb06a44799c9c440d2d",
  "document": "43591367000130",
  "policyStatus": "DENIED",
  "status": {
    "id": "6614758260513064a5af1046",
    "value": "PENDING",
    "title": "Não iniciado"
  },
  "createdAt": "2026-02-27T21:08:11.938Z",
  "updatedAt": "2026-02-27T21:08:11.938Z"
}

​
Quando usar

Use este endpoint para iniciar uma nova análise de crédito para CPF ou CNPJ. Você pode usar quando receber uma solicitação de avaliação de cliente e precisar gerar um relatório com base na política de decisão selecionada.

​
Autenticação

Bearer JWT no header Authorization.

​
Parâmetros

NomeLocalTipoObrigatórioDescrição
frontquerystringsimParâmetro da requisição.

​
Corpo da requisição

{
  "policyId": "string",
  "document": "string",
  "type": "string"
}

Authorizations

​
Authorization
string
header
required

Enter JWT token

Query Parameters

​
front
string
required

Body

application/json
​
policyId
string
required
​
document
string
required
​
type
string
required

Response

200 - undefined