Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
Verifiable Credentials

Issue Credential

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

API scope required credentials.create

post/v1-alpha1/credentials/templates/{templateId}/vcs

Path parameters

templateIdstring required

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

Request body

recipientstring required

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

sendNotificationboolean

Notify recipient via email notification about successful mint [Default: true]. For legacy projects created before Sep 16, 2024, this is set to false by default.

localestring

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

Example request

{
  "recipient": "polygon:0x1234abcde... or email:<email_address>:polygon",
  "locale": "en-US",
  "metadata": {
    "name": "Crossmint Example Verifiable Credential NFT",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "My Verifiable Credential NFT created via the mint API!"
  },
  "credential": {
    "subject": {
      "subjectName": "foo",
      "subjectAge": 20,
      "claim": "bar"
    }
  }
}

Response

Success.

idstring

Uniquely identifies the transaction in the system.

credentialIdstring

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

actionIdstring

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.

Example response

{
  "credentialId": "urn:uuid:credentialId"
}