Skip to main content
POST
/
v1
/
holder
/
{holderId}
/
organization
/
{organizationId}
/
partner
/
process
cURL
curl --request POST \
  --url https://search.tratum.com.br/v1/holder/{holderId}/organization/{organizationId}/partner/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "<string>",
  "documentNumber": "<string>"
}
'
{
  "success": true,
  "reason": "<string>",
  "total": 123,
  "result": [
    {
      "accessPauseMonitor": true,
      "documentInfo": "<string>",
      "dayPauseMonitor": 123,
      "documentType": "<string>",
      "documentNumber": "<string>",
      "consume": 123,
      "typePlan": "<string>",
      "userPlanConsumeUniqueId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "planChangedAt": "2023-11-07T05:31:56Z",
      "dtAvailablePause": "2023-11-07T05:31:56Z",
      "typeSearch": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tratum.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json

Corpo da requisição

​
documentType
string

Tipo do documento, somente duas opções válidas: CPF | CNPJ

​
documentNumber
string

Valor do documento CPF / CNPJ

Response

Resultado do consumo de plano do usuário

​
success
boolean

Indica se a operação foi bem-sucedida

​
reason
string

Razão de falha ou código adicional

​
total
integer

Total de registros encontrados

​
result
object[]