Skip to main content
GET

Quando usar

Use esta rota para descobrir o policyId que vai em POST /v2/report. Para a API, escolha uma política com enabled: true e usage: REPORT: política desabilitada ou de esteira é recusada na criação do relatório.

Autenticação

Bearer JWT no header Authorization. A lista traz as políticas da organização do token.

Parâmetros

Resposta

Um array de políticas. Campos principais:

Authorizations

Authorization
string
header
required

Enter JWT token

Query Parameters

percentages
enum<string>

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

Available options:
true,
false
enabled
enum<string>

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

Available options:
true,
false
protected
enum<string>

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

Available options:
true,
false
usage
enum<string>

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

Available options:
REPORT,
PIPELINE
includeUser
enum<string>

true acrescenta user, com quem criou a politica.

Available options:
true,
false

Response

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

id
string
name
string
reportType
string
documentType
enum<string>
Available options:
CNPJ,
CPF
bureauType
string
hasSCR
boolean
balanceRuleEnabled
boolean
enabled
boolean

Politica desabilitada nao pode ser executada.

usage
enum<string>

So REPORT roda em POST /v2/report.

Available options:
REPORT,
PIPELINE
kind
enum<string>
Available options:
BASE,
LAYER
version
number
parecerEnabled
boolean
integrationGroup
object | null
organizationId
string
createdAt
string<date-time>