Create Credential template

Create a template, similar to an NFT collection, for issuing verifiable credentials.

API scope required credentials:template.create

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.

Body

application/json

metadata

object

required

Show child attributes

metadata.name

string

required

The name of your collection (Max length: 32).

Maximum length: 32

Example:

"Verifiable Credential"

metadata.image

string

required

Direct link to your Verifiable Credential Template image.

Example:

"https://www.crossmint.com/assets/crossmint/logo.png"

metadata.description

string

required

A brief description of credential (Max length: 64).

Maximum length: 64

Example:

"The owner of this credential is authorized."

chain

enum<string>

required

The chain to mint the nft on. All crossmint supported EVM chains are compatible.

Available options:

polygon,

optimism,

base,

etc...

credentials

object

required

Credentials parameters

Show child attributes

credentials.type

string

required

The type of credentials inside the collection.

Example:

"crossmint:5fe6040e-07a1-48bb-97a3-b588a7e927d2:CourseCompletionCertificate"

credentials.storage

enum<string>

required

Where to store the credential

Available options:

crossmint,

crossmint-private,

decentralized-ipfs,

delegated

credentials.encryption

enum<string>

required

Whether to encrypt the credential, ensuring data privacy. Only the subject and issuer have the authentication to decrypt the credential.

Available options:

crossmint-recoverable,

decentralized-lit,

none

credentials.delegatedStorageEndpoint

string

Only if storage is 'delegated', the endpoint to retrieve the credential from

Example:

"unknown"

credentials.delegatedSignature

object

Issuer information, fill only if using delegated storage.

Show child attributes

credentials.delegatedSignature.did

string

required

The issuer's did

Example:

"did:polygon:0x123456789"

credentials.delegatedSignature.endpoint

string

required

The issuer's endpoint to sign credentials

Example:

"https://issuer.com/sign"

credentials.delegatedSignature.token

string

required

Token used for auth on the issuer endpoint

Example:

"abcd"

Example:

"undefined"

Response

200

application/json

Success. Refer to the standard create collection response for more details.

The response is of type string.

Example:

"Success. Refer to the standard nft create collection response for more details."