Issue Credential

Issue a credential and deliver it to a wallet or email address.

API scope required credentials.create

This is an alpha API and subject to change.

Authorizations

X-API-KEY

string

headerrequired

Key obtained from the Crossmint developer console, reflecting the API scope granted.

Path Parameters

templateId

string

required

The credential template's id that the newly issued credential is related to.

Body

application/json

recipient

string

required

Recipient address in the format of <chain>:<address> or email:<email_address>:<chain>.

credential

object

required

Show child attributes

credential.subject

object

required

Object matching the collection type's schema populated with values relevant to the credential's recipient.

credential.expiresAt

string

default: 2023-08-31T16:34:33.854Zrequired

The expiration date should be set in ISO 8601 format or as “none” to indicate no expiration. For example, an ISO 8601 date could be "2030-12-31"

sendNotification

boolean

Notify recipient via email notification about successful mint [Default: true]. Learn how this applies to legacy projects.

locale

string

Specify the locale for the email content [Default: en-US]

metadata

object

Descriptive information inherited, by default, from the credential's template.

Show child attributes

metadata.name

string

required

The name of your Verifiable Credential NFT (Max length: 32).

Maximum length: 32

metadata.image

string

Direct link to your Verifiable Credential NFT image.

metadata.description

string

A brief description of the Verifiable Credential NFT (Max length: 64).

Maximum length: 64

metadata.attributes

object[]

Add attributes to your Verifiable Credential NFT

Show child attributes

metadata.attributes.display_type

enum<string>

Display name of your attribute

Available options:

boost_number,

boost_percentage,

number

metadata.attributes.trait_type

string

required

The name of the trait

metadata.attributes.value

string

required

The value of the trait

Response

200 - application/json

id

string

Uniquely identifies the transaction in the system.

onChain

object

Information on the credential's current status on the blockchain, specifying its status on the specified network and related smart contract address.

Show child attributes

onChain.status

string

Current state of the credential on the blockchain (e.g., "pending").

onChain.chain

string

Blockchain network where the credential is recorded (e.g., "polygon")

onChain.contractAddress

string

Smart contract address on the specified blockchain (e.g., "0x123456789").

credentialId

string

Key identifier for the credential itself, distinct from the transaction or record as a whole.

actionId

string

Represents the action or transaction ID. In this context, it is the same as the primary id, indicating reference to the same overarching transaction or operation.