report

Criar relatorio (API v2)

Cria a analise de um CPF ou CNPJ com a politica informada. Use para novas integracoes. Corpo: document (obrigatorio, digito verificador validado), policyId (obrigatorio, politica habilitada e de usage REPORT) e months (opcional). O campo type e ignorado: o tipo vem da politica.

Mesmo documento, politica, versao da politica e dia: devolve o relatorio que ja existe (decidido, sem reprocessar; PENDING, com a coleta disparada de novo).

Erros: 400 politica ausente, nao habilitada ou de esteira; 422 documento de tipo diferente do da politica; 503 com reportId quando o relatorio foi criado mas a analise nao foi enfileirada.

post/v2/report

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v2/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

Sucesso.

object required

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.

Changes

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