Skip to main content
POST
Preview what a mint would disclose

Authorizations

X-API-Key
string
header
required

Body

The individual mint body, so one body previews and then mints. agent_key is optional and unused.

audience
string
required

The counterparty the credential is scoped to: a bare domain (login.example.com), or an https authorization-server identifier (https://login.example.com) kept whole, which derives a different pairwise subject than the bare host. Paths, queries, fragments and non-default ports are refused.

Required string length: 1 - 512
individual_ref
string
required

Pairwise reference to the verified individual, as issued to the calling organization at verification completion.

Required string length: 1 - 255
type
string
required

individual: the person as themselves.

Allowed value: "individual"
format
enum<string>
default:dc+sd-jwt

Credential wire format. dc+sd-jwt (media type application/dc+sd-jwt, draft-ietf-oauth-sd-jwt-vc-19 §2.1) is the only format issued.

Available options:
dc+sd-jwt
ttl_seconds
integer | null

Maximum credential validity in seconds, capped at supporting evidence expiry. Omitted or null uses the server default (3600 seconds). Must not exceed the configured maximum (86400 seconds by default).

Required range: x > 0
disclosed_fields
string[]

The dotted disclosure paths the subject credential should carry, e.g. email, or hashes.email for its recognition hash alone. A path the person's record cannot back is refused. A business mint lists business paths here and the actor credential's paths, e.g. given_name, in actor_disclosed_fields. Neither this nor preset: a pairwise-only credential.

Maximum array length: 64
preset
enum<string> | null

Disclose a use case's fields instead of listing disclosed_fields; never both. GET /issuance/credentials/presets lists each preset's paths, and every one must be backed, as a listed path must. B2B presets need a business mint.

Available options:
consumer_ecommerce,
age_gated,
consumer_regulated,
b2b_ecommerce,
b2b_regulated
agent_key
CredentialAgentKey (v1) · object | null

Accepted so a mint body previews unchanged; a preview binds no key.

Response

Response

Body of POST /issuance/credentials/preview: what a mint with the same body would disclose, without signing, storing or allocating anything. It refuses as the mint would, so a requested path with nothing to back it is refused here too.

environment
enum<string>
required

The application lane the mint would run in: production for a live application, sandbox for a test one. A self-mint has no test application, so it is always production. The lane does not name the deployment: read that from the token's iss, in the issuer-signed JWT payload (the segment before the first ~).

Available options:
sandbox,
production
ttl_capped
boolean
required

Whether supporting evidence expiry would shorten the requested validity.

credentials
CredentialPreviewEntry (v1) · object[]
required

The credentials a mint would produce, subject first.