Skip to main content
POST
Mint enrollment code

Authorizations

X-API-Key
string
header
required

Body

application/json
retailer_id
string<shortuuid>
required

Retailer to scope the minted code to.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
retailer_id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
retailer_name
string
required

The retailer this code is scoped to, for display.

status
enum<string>
required

Current redemption status.

Available options:
pending,
consumed,
revoked,
expired
expires_at
string
required

ISO 8601 expiry timestamp.

created
string
required

ISO 8601 mint timestamp.

code
string
required

The code to give the retailer, formatted for on-screen display/readback (hyphen-grouped). Shown here and via GET while still pending — this is not a one-shot secret like an API key, since the consumer may need to re-display a still-live code.