Criar Relatório (v2)

Dispara uma nova análise de crédito para CPF ou CNPJ com o payload revisado da v2.

Quando usar

Use este endpoint para iniciar uma nova análise de crédito para CPF ou CNPJ. A chamada é assíncrona: retorna imediatamente o id do relatório com status inicial PROCESSING e você recebe o resultado final via webhook ou consultando GET /v2/report/{id}.

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição
document	body	string	sim	CPF (11 dígitos) ou CNPJ (14 dígitos), somente números.
type	body	string	sim	Tipo do documento. Valores aceitos: cpf ou cnpj.
policyId	body	string	sim	ID da política de decisão que será aplicada. Obtenha em GET /credit-policy/policy.

Corpo da requisição

{
  "document": "43591367000130",
  "type": "cnpj",
  "policyId": "69a1fbb06a44799c9c440d2d"
}

cURL

curl --location 'https://gyra-core.gyramais.com.br/v2/report' \
--header 'Authorization: Bearer abc123' \
--header 'Content-Type: application/json' \
--data-raw '{
  "document": "43591367000130",
  "type": "cnpj",
  "policyId": "69a1fbb06a44799c9c440d2d"
}'

A requisição retorna o id e o status inicial do relatório. Você pode configurar um webhook para receber a conclusão em tempo real ou consultar GET /v2/report/{id} para obter o status atualizado.

200 OK

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