Pular para o conteúdo principal
GET
List beneficiaries

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

taxId
string

CPF ou CNPJ do beneficiário.

status
enum<string>
Opções disponíveis:
ACTIVE,
BLOCKED,
INACTIVE
relationshipType
enum<string>
Opções disponíveis:
SELF_OWNED,
THIRD_PARTY
cursor
string

Cursor opaco retornado em pagination.nextCursor.

limit
integer
padrão:20
Intervalo obrigatório: 1 <= x <= 100

Resposta

Beneficiaries

data
object[]
pagination
object