POST
/
unstable
/
collections
/
{collectionId}
/
credentials
curl --request POST \
  --url https://staging.crossmint.com/api/unstable/collections/{collectionId}/credentials \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "credential": {
    "expiresAt": "<string>",
    "subject": {
      "claim": "bar",
      "subjectAge": 20,
      "subjectName": "foo"
    }
  },
  "metadata": {
    "animation_url": "<string>",
    "attributes": [
      {
        "display_type": "boost_number",
        "trait_type": "<string>",
        "value": "<string>"
      }
    ],
    "description": "My NFT created via the mint API!",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "name": "Crossmint Example NFT"
  },
  "recipient": "polygon:0x1234abcde... or email:<email_address>:polygon"
}'
{
  "credentialId": "urn:uuid:40ada19e-3b4a-4de0-8d61-e0e7aedbfa0",
  "id": "1938b38c-3037-45dc-8033-333b7ebaee7",
  "nft": {
    "onChain": {
      "chain": "ethereum",
      "contractAddress": "0x123456789",
      "status": "pending"
    }
  },
  "retrievalId": "urn:uuid:40ada19e-3b4a-4de0-8d61-e0e7aedbfa0"
}

This is an alpha API and subject to change.

Authorizations

X-API-KEY
string
headerrequired

Obtained in the Crossmint developer console

Path Parameters

collectionId
string
required

Collection id of a credential enabled collection

Body

application/json
credential
object
required
metadata
object
recipient
string
required

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

Response

200 - application/json
credentialId
string

The credential id

id
string
onChain
object