Skip to main content
GET
List ownership assignments

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

page
integer<int64>
default:1

Page, 1-based.

Required range: x >= 1
limit
integer<int64>
default:50

Items per page.

Required range: 1 <= x <= 200
engineId
string

Filter by owning engine.

keyKind
enum<string>
Available options:
ACCOUNT,
DOCUMENT,
PIX_KEY_EMAIL,
PIX_KEY_PHONE,
PIX_KEY_RANDOM,
PAYMENT_ID,
PIX_RECURRENCE_ID
keyValue
string

Exact match after per-kind normalization, for every kind except ACCOUNT. Requires keyKind.

Maximum string length: 256
branch
string

ACCOUNT only, with account: a current account's branch. Omit it for a payment account.

Maximum string length: 256
account
string

ACCOUNT only: the account number, with branch for a current account. Alone, it matches the payment account only.

Maximum string length: 256

Response

OK

items
object[] | null
required
limit
integer<int64>
required
Required range: x >= 1
page
integer<int64>
required
Required range: x >= 1