report

Criar relatorio (padrao de integracao com webhook)

PADRAO DE INTEGRACAO, use quando voce esta ajudando um desenvolvedor a implementar integracao programatica com webhook. Para um usuario apenas gerando relatorio no chat, use create_report_and_wait.

Cria um novo relatorio de analise de credito para um CPF ou CNPJ.

O processamento e ASSINCRONO: voce recebe o reportId imediatamente com status PENDING. O cliente acompanha o ciclo via:

  1. Webhook configurado (create_webhook), recomendado para integracoes.
  2. Polling em get_report ate reportProgress.isFinalized === true.

Status do relatorio: PENDING ate uma decisao; APPROVED ou REJECTED depois de analyze_report. O resultado da politica fica em policyStatus.

O tipo de relatorio (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+) e determinado pela politica de credito (policyId) utilizada.

Use list_policies (ou find_policy_by_name pra fluxo interativo) para obter os policyIds disponiveis na organizacao.

post/report

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/report
  • Auth: HTTP bearer

Request body

policyIdstring required

Politica habilitada e de usage REPORT.

documentstring required

CPF ou CNPJ sem mascara. Digito verificador validado; CNPJ alfanumerico aceito.

typestring

Ignorado. O tipo vem da politica.

monthsinteger

Meses de historico do SCR. Padrao: o da politica, depois o da organizacao, depois 12.

Response

Objeto do relatorio com id, status (PENDING), document, type e createdAt.

object required

O relatorio recem-criado (API v1).

Changes

No recorded changes to this operation across all 1 revision of this API.