Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Credentials

Mint a credential for a person as a business operator

Mints an L2 or L3 SD-JWT-VC credential for a verified person acting as the operator of a verified business. The business identity assumed is always explicit via business_ref — it is never inferred — and minting requires a verified operator link between the person and that business.

post/credentials/business

Request body

principal_refstring required

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

level'L2' | 'L3' required

The credential layer a subject mint request selects (KYA).

Deliberately narrower than IssuedCredentialType: the individual and business mint routes issue only the two subject layers. Counterparty credentials have their own route and request shape, so a level of COUNTERPARTY must stay an edge-level payload refusal — this enum is what keeps issuance-record vocabulary growth from widening the mint requests.

audiencestring required

The counterparty the credential is scoped to — a domain, or a URL reduced to its hostname.

disclosed_fieldsstring[]

L3 only: the dotted disclosure paths the credential should carry, e.g. user.email.hash. Individual mints take user.* paths; business mints take business.* and actor.user.* paths.

disclosure_mode'CLEARTEXT_AND_HASH' | 'HASH_ONLY'

Per-mint selective-disclosure mode for L3 credentials.

CLEARTEXT_AND_HASH (the default) discloses requested fields as cleartext alongside their recognition hashes; HASH_ONLY discloses only the recognition hashes, giving counterparties recognition without plaintext.

business_refstring required

Pairwise reference to the verified business whose identity the principal assumes, as issued to the calling organization.

Response

Response

credentialstring required

The SD-JWT-VC wire string.

credential_type'L2' | 'L3' | 'COUNTERPARTY' required

The KYA credential layer.

L2 is the audience-scoped pairwise DID ("same customer returning"); L3 is the selectively disclosed verified-identity credential. Both ride the same SD-JWT-VC wire format; the layer decides what the issuer JWT carries. Counterparty is the counterparty-verification credential (ENG-6598): a domain-bound business entity attestation a merchant hosts for arriving agents — plain JWS, no selective disclosure, no agent key.

jtistring required

The credential's unique token id; the issuance-record handle.

principal_refstring required

The pairwise principal reference minted for.

business_refstring nullable

The pairwise business reference minted for; null on individual mints.

audiencestring required

The canonical counterparty domain the credential is scoped to.

issued_atstring date-time required

Issuance instant (the issuer JWT's iat).

expires_atstring date-time required

Expiry instant (the issuer JWT's exp).

disclosed_fieldsstring[]

The dotted disclosure paths the credential carries.

active_keysstring[]

Dotted keys of the identity attributes the credential attests to (on business mints, the union of the business and actor scopes).