Skip to main content
POST
/
v2
/
analytics
cURL
curl --request POST \
  --url https://search.tratum.com.br/v2/analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "holderId": 123,
  "organizationId": 123,
  "planId": 123,
  "documentType": "<string>",
  "documentNumber": "<string>"
}
'
{
  "result": {
    "documentInfo": "<string>",
    "documentNumber": "<string>",
    "statusIndex": "<string>",
    "statusProtest": "<string>",
    "lastUserPlanConsumeAnalytics": 123,
    "statusReport": "<string>",
    "typePlan": "<string>",
    "userPlanConsumeUniqueId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "userPlanConsumeAnalyticsId": 123,
    "totalProcessesEstimated": 123,
    "status": "<string>"
  },
  "status": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Corpo da requisição

holderId
integer

ID do parceiro

organizationId
integer

ID da organização

planId
integer

ID do plano

documentType
string

Tipo de documento CNPJ | CPF

documentNumber
string

Número do documento

Response

Resultado da análise premium com protesto

result
object
status
string

Status da resposta (ex: success)