This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Request to mint (and reveal once) an API key owned by a specific merchant user, provisioned by a
reseller or admin. The server resolves and scope-checks the target user against
`merchantId`; the caller is authorized over that merchant server-side. The revealed key
is returned once in the response and never persisted in clear or logged.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
userIdrequired
string (uuid)
The identity user the key is minted for (the owner). Must be an active merchant user of
`merchantId` in the current tenant.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantIdrequired
string (uuid)
The merchant the target user belongs to, used for the server-side scope check.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
namerequired
string
Human-readable key name.nullablemax length 32
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
expireAtrequired
string (date-time)
Required expiry. A durable credential provisioned for another user must not be immortal,
so a null value is rejected.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.