credit-policy/policy

Listar politicas de credito

Lista as politicas de credito da organizacao.

Cada politica define:

  • Quais fontes de dados consultar (bureau de credito, SCR/Open Finance, etc.)
  • Regras de aprovacao automatica (score, limites, restricoes)
  • Tipo de relatorio gerado (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+)
  • Grupos de regras com pesos e thresholds

O policyId retornado e necessario para criar relatorios (create_report). Para a API, use uma politica com enabled true e usage REPORT.

Filtros opcionais (valores como string):

  • enabled: true para ver apenas politicas habilitadas
  • usage: REPORT ou PIPELINE
  • protected: true para incluir politicas protegidas
get/credit-policy/policy

Request

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

Query parameters

percentages'true' | 'false'

true acrescenta percentages, a distribuicao dos resultados de cada politica.

enabled'true' | 'false'

true traz so as politicas habilitadas para a organizacao; false, so as desabilitadas.

protected'true' | 'false'

true inclui tambem as politicas protegidas, que nao pertencem a organizacao.

usage'REPORT' | 'PIPELINE'

REPORT (roda sozinha, inclusive em POST /v2/report) ou PIPELINE (so roda dentro de esteira).

includeUser'true' | 'false'

true acrescenta user, com quem criou a politica.

Response

Array de politicas com id, name, enabled, documentType, grupos de regras e configuracoes.

idstring
namestring
reportTypestring
documentType'CNPJ' | 'CPF'
bureauTypestring
hasSCRboolean
balanceRuleEnabledboolean
enabledboolean

Politica desabilitada nao pode ser executada.

usage'REPORT' | 'PIPELINE'

So REPORT roda em POST /v2/report.

kind'BASE' | 'LAYER'
versionnumber
parecerEnabledboolean
integrationGroupobject nullable
organizationIdstring
createdAtstring date-time

Changes

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