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

headerrequired

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

metadata.image

string

required

Direct link to your Verifiable Credential Template image.

metadata.description

string

required

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

Maximum length: 64

chain

enum<string>

required

The chain to mint the nft on.

Available options:

polygon

credentials

object

required

Credentials parameters

Show child attributes

credentials.type

string

required

The type of credentials inside the collection.

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

credentials.delegatedSignature

object

Issuer information, fill only if using delegated storage.

Show child attributes

credentials.delegatedSignature.did

string

required

The issuer's did

credentials.delegatedSignature.endpoint

string

required

The issuer's endpoint to sign credentials

credentials.delegatedSignature.token

string

required

Token used for auth on the issuer endpoint

Response

200 - application/json

The response is of type string.