curl --request POST 'https://gyra-core.gyramais.com.br/v2/report' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000"
}'
const resposta = await fetch("https://gyra-core.gyramais.com.br/v2/report", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
document: "11222333000181",
policyId: "6612a7f3625ea4ab00000000",
}),
});
const relatorio = await resposta.json();
import requests
resposta = requests.post(
"https://gyra-core.gyramais.com.br/v2/report",
headers={"Authorization": f"Bearer {token}"},
json={
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000",
},
)
relatorio = resposta.json()
{
"reportProgress": {
"steps": [
{
"event": "REPORT_CHECKING",
"message": "Report sent to check the document."
}
]
},
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:42:37.059Z",
"document": "11222333000181",
"organizationId": "6612a7f3fa9e086b00000000",
"customerId": "6612a7f388be48e900000000",
"months": 12,
"policyVersion": 3,
"verified": false,
"operationId": null,
"operationResultId": null,
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
}
}
{
"code": 400,
"message": "Você precisa inserir um CNPJ ou CPF válido."
}
{
"code": 422,
"message": "The provided document does not match the selected policy"
}
{
"code": 503,
"message": "Não foi possível iniciar a análise do relatório. Tente novamente em alguns instantes.",
"reportId": "6612a7f3a19b467000000000"
}
Referência da API
Criar Relatório (v2)
Dispara uma análise de crédito para um CPF ou CNPJ com a política que você escolher.
POST
/
v2
/
report
curl --request POST 'https://gyra-core.gyramais.com.br/v2/report' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000"
}'
const resposta = await fetch("https://gyra-core.gyramais.com.br/v2/report", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
document: "11222333000181",
policyId: "6612a7f3625ea4ab00000000",
}),
});
const relatorio = await resposta.json();
import requests
resposta = requests.post(
"https://gyra-core.gyramais.com.br/v2/report",
headers={"Authorization": f"Bearer {token}"},
json={
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000",
},
)
relatorio = resposta.json()
{
"reportProgress": {
"steps": [
{
"event": "REPORT_CHECKING",
"message": "Report sent to check the document."
}
]
},
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:42:37.059Z",
"document": "11222333000181",
"organizationId": "6612a7f3fa9e086b00000000",
"customerId": "6612a7f388be48e900000000",
"months": 12,
"policyVersion": 3,
"verified": false,
"operationId": null,
"operationResultId": null,
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
}
}
{
"code": 400,
"message": "Você precisa inserir um CNPJ ou CPF válido."
}
{
"code": 422,
"message": "The provided document does not match the selected policy"
}
{
"code": 503,
"message": "Não foi possível iniciar a análise do relatório. Tente novamente em alguns instantes.",
"reportId": "6612a7f3a19b467000000000"
}
Quando usar
Use esta rota para iniciar a análise de um CPF ou CNPJ. A chamada é assíncrona: devolve oid do relatório na hora, com status PENDING, e a análise segue em segundo plano. Acompanhe pelo webhook REPORT_FINISHED ou consultando GET /v2/report/{id}.
Autenticação
Bearer JWT no headerAuthorization. A credencial precisa da permissão de criar relatórios pela API.
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
document | string | sim | CPF ou CNPJ, sem máscara. O dígito verificador é validado. O CNPJ alfanumérico é aceito. |
policyId | string | sim | ID da política. Use uma política habilitada e de relatório (usage: REPORT), listada em GET /credit-policy/policy. |
months | integer | não | Meses de histórico do SCR. Sem o campo, vale o configurado na política, depois o da organização, e por fim 12. |
type | string | não | Ignorado. O tipo de relatório e o tipo de documento vêm da política. Aceito por compatibilidade. |
{
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000"
}
422.
Mesmo documento, mesma política, mesmo dia
Um relatório é identificado por documento, política, versão da política e dia. Repetir oPOST com essa mesma combinação no mesmo dia não cria um segundo relatório:
| Situação do relatório do dia | O que o POST devolve |
|---|---|
Já decidido (APPROVED ou REJECTED) | O relatório existente, com o mesmo id, sem reprocessar. |
Ainda PENDING | O mesmo id, e a coleta das fontes é disparada de novo sobre ele. |
Se a resposta for
503 com reportId no corpo, o relatório já foi criado, mas a análise não pôde ser iniciada. Consulte esse reportId antes de tentar de novo.curl --request POST 'https://gyra-core.gyramais.com.br/v2/report' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000"
}'
const resposta = await fetch("https://gyra-core.gyramais.com.br/v2/report", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
document: "11222333000181",
policyId: "6612a7f3625ea4ab00000000",
}),
});
const relatorio = await resposta.json();
import requests
resposta = requests.post(
"https://gyra-core.gyramais.com.br/v2/report",
headers={"Authorization": f"Bearer {token}"},
json={
"document": "11222333000181",
"policyId": "6612a7f3625ea4ab00000000",
},
)
relatorio = resposta.json()
{
"reportProgress": {
"steps": [
{
"event": "REPORT_CHECKING",
"message": "Report sent to check the document."
}
]
},
"id": "6612a7f3a19b467000000000",
"createdAt": "2026-07-31T13:42:37.059Z",
"updatedAt": "2026-07-31T13:42:37.059Z",
"document": "11222333000181",
"organizationId": "6612a7f3fa9e086b00000000",
"customerId": "6612a7f388be48e900000000",
"months": 12,
"policyVersion": 3,
"verified": false,
"operationId": null,
"operationResultId": null,
"status": {
"id": "6612a7f3410dcd8100000000",
"value": "PENDING"
}
}
{
"code": 400,
"message": "Você precisa inserir um CNPJ ou CPF válido."
}
{
"code": 422,
"message": "The provided document does not match the selected policy"
}
{
"code": 503,
"message": "Não foi possível iniciar a análise do relatório. Tente novamente em alguns instantes.",
"reportId": "6612a7f3a19b467000000000"
}
Erros
| Código | Mensagem | Causa |
|---|---|---|
400 | "Você precisa inserir um CNPJ ou CPF válido." | document ausente ou com dígito verificador inválido. |
400 | "policyId not defined" | Corpo sem policyId. |
400 | "Política não está habilitada para ser utilizada" | policyId inexistente ou política não habilitada para a sua organização. |
400 | "Esta política é de esteira: rode a esteira que a usa." | A política é de esteira e não roda sozinha. |
401 | "Token de acesso inválido." | Token ausente ou expirado. |
403 | "Você não tem permissão para acessar este recurso." | A credencial não tem a permissão de criar relatórios pela API. |
422 | "The provided document does not match the selected policy" | Tipo de documento diferente do da política. |
503 | "Não foi possível iniciar a análise do relatório. Tente novamente em alguns instantes." | O relatório foi criado, mas a análise não foi enfileirada. Use o reportId do corpo. |
Body
application/json
Response
Sucesso.
O relatorio criado. O processamento e assincrono: acompanhe pelo webhook REPORT_FINISHED ou por GET /v2/report/{id}. Mesmo documento, politica, versao e dia devolvem o mesmo relatorio.

