POST
/
v1-alpha1
/
credentials
/
templates
/
{templateId}
/
vcs
curl --request POST \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/templates/{templateId}/vcs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "recipient": "polygon:0x1234abcde... or email:<email_address>:polygon",
  "sendNotification": true,
  "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!",
    "attributes": [
      {
        "display_type": "boost_number",
        "trait_type": "<string>",
        "value": "<string>"
      }
    ]
  },
  "credential": {
    "subject": {
      "subjectName": "foo",
      "subjectAge": 20,
      "claim": "bar"
    },
    "expiresAt": "2023-08-31T16:34:33.854Z"
  }
}'
{
  "id": "1938b38c-3037-45dc-8033-333b7ebaee7",
  "onChain": {
    "status": "pending",
    "chain": "polygon",
    "contractAddress": "0x123456789"
  },
  "credentialId": "urn:uuid:40ada19e-3b4a-4de0-8d61-e0e7aedbfa0",
  "actionId": "1938b38c-3037-45dc-8033-333b7ebaee7"
}

This is an alpha API and subject to change.

Authorizations

​
X-API-KEY
string
header
required

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

Response

200
application/json

Success.

The response is of type object.