Skip to main content
POST
Resolve which engine owns a key

Authorizations

Authorization
string
header
required

An Access Manager application token whose subject is bound to exactly one engine; an engine may hold several, one per calling product. It reaches only the operations its scopes name; the operator surface refuses it.

Scopes

ownership:read

Read the ownership map

Body

application/json
keyKind
enum<string>
required

The kind of key.

Available options:
ACCOUNT,
DOCUMENT,
PIX_KEY_EMAIL,
PIX_KEY_PHONE,
PIX_KEY_RANDOM,
PAYMENT_ID,
PIX_RECURRENCE_ID,
PIX_RECURRENCE_ID_CHARGER
account
string

ACCOUNT only: the account number, digits with an optional trailing check-digit letter.

Maximum string length: 256
branch
string

ACCOUNT only: a current account's branch, 1 to 4 digits. Omit it, or send it empty, for a payment account, which has none; empty is never branch 0.

Maximum string length: 256
keyValue
string

The key as the caller holds it, for every kind except ACCOUNT. Do not pre-normalize.

Required string length: 1 - 256

Response

OK

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

The normalized form the Courier resolved against.

Maximum string length: 256
resolved
boolean
required
resolvedAt
string<date-time>
required
source
enum<string>
required
Available options:
ASSIGNMENT_MAP
engineId
string

Present only when resolved is true.

ownedByCaller
boolean

Present only when resolved is true: whether the owner is the engine whose credential made this call. Compare on this; an engine never needs its own registry id.