Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

holderId
integer<int64>
required

ID do parceiro

organizationId
integer<int64>
required

ID da organização

userPlanConsumeUniqueId
integer<int64>
required

Identificador único do consumo

userPlanConsumeAnalyticsId
integer<int64>
required

Identificador único da análise

Query Parameters

size
integer<int64>

Quantidade de itens na resposta

typeRisk
integer<int64>
required

Classificação de risco: RISK_WORKER | RISK_EXECUTION | RISK_CRIMINAL | LITIGATION

Response

200 - application/json

Resposta com detalhes de uma análise por classificação de risco

sucess
boolean

Indica se a operação foi bem-sucedida

reason
string

Motivo da resposta (caso haja algum erro ou mensagem)

register
object