Skip to main content
POST
Assign a key to an engine

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key; a retry with the same key and body replays the first answer.

Body

application/json
engineId
string
required
Pattern: ^[a-z0-9-]{1,32}$
keyKind
enum<string>
required
Available options:
ACCOUNT,
DOCUMENT,
PIX_KEY_EMAIL,
PIX_KEY_PHONE,
PIX_KEY_RANDOM,
PAYMENT_ID,
PIX_RECURRENCE_ID
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

Raw value, for every kind except ACCOUNT. The Courier normalizes per kind — do not pre-normalize.

Required string length: 1 - 256
note
string

Recorded in the audit. Recommended during a wave migration.

Maximum string length: 512

Response

Already assigned to this engine. No new audit entry.

assignmentId
string<uuid>
required
engineId
string
required
Pattern: ^[a-z0-9-]{1,32}$
keyKind
enum<string>
required
Available options:
ACCOUNT,
DOCUMENT,
PIX_KEY_EMAIL,
PIX_KEY_PHONE,
PIX_KEY_RANDOM,
PAYMENT_ID,
PIX_RECURRENCE_ID
keyValue
string
required

Normalized form. This is what the rails resolve against. ACCOUNT is :, and : for a payment account.

Maximum string length: 256
updatedAt
string<date-time>
required
keyValueRaw
string

Exactly what the operator typed.

Maximum string length: 256
previousEngineId
string | null

Present after a move.

updatedBy
string
Maximum string length: 128