Assign a key to an engine

A double owner is inexpressible: a key owned by a different engine is refused 409 JDC-0102, which points at the move operation. Re-assigning to the current owner is a no-op answered 200, with no new audit entry.

POST /v1/ownership/assignments

Assign a key to an engine

cURL

curl --request POST \
  --url https://api.example.com/v1/ownership/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "engineId": "<string>",
  "account": "<string>",
  "branch": "<string>",
  "keyValue": "<string>",
  "note": "<string>"
}
'

200

{
  "assignmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "engineId": "<string>",
  "keyKind": "ACCOUNT",
  "keyValue": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "keyValueRaw": "<string>",
  "previousEngineId": "<string>",
  "updatedBy": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

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

Cuerpo

application/json

engineId · string · requerido

Pattern: ^[a-z0-9-]{1,32}$

keyKind · enum<string> · requerido

Opciones disponibles: 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

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

Respuesta

200

application/json

Already assigned to this engine. No new audit entry.

assignmentId · string<uuid> · requerido

engineId · string · requerido

Pattern: ^[a-z0-9-]{1,32}$

keyKind · enum<string> · requerido

Opciones disponibles: ACCOUNT, DOCUMENT, PIX_KEY_EMAIL, PIX_KEY_PHONE, PIX_KEY_RANDOM, PAYMENT_ID, PIX_RECURRENCE_ID, PIX_RECURRENCE_ID_CHARGER

keyValue · string · requerido

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

Maximum string length: 256

updatedAt · string<date-time> · requerido

keyValueRaw · string

Exactly what the operator typed.

Maximum string length: 256

previousEngineId · string | null

Present after a move.

updatedBy · string

Maximum string length: 128