Skip to main content
POST
Register 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
credentialSubject
string
required
Required string length: 1 - 256
engineId
string
required
Pattern: ^[a-z0-9-]{1,32}$
displayName
string
Maximum string length: 128
participants
string[] | null

The direct-participant ISPBs this engine acts as. Omitted or empty is legal, and an ISPB another engine already declares is accepted: a shared ISPB across two cores is the coexistence case itself.

Pattern: ^[0-9]{8}$
pixDelivery
object

Where the Courier delivers the Pix messages the ownership map gives this engine; https in production, and setting it needs the admin grant (engines pix-delivery:write). Omitted: the engine takes none, and such a message is retained.

Response

Created

createdAt
string<date-time>
required
credentialSubject
string
required
Maximum string length: 256
displayName
string
required
Maximum string length: 128
enabled
boolean
required
engineId
string
required
Pattern: ^[a-z0-9-]{1,32}$
participants
string[]
required
Pattern: ^[0-9]{8}$
disabledAt
string<date-time> | null
pixDelivery
object