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

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
​
credential
object
required
​
recipient
string
required

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

​
locale
string

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

​
metadata
object

Descriptive information inherited, by default, from the credential's template.

​
sendNotification
boolean

Notify recipient via email notification about successful mint [Default: true]. Learn how this applies to legacy projects.

Response

200 - application/json
​
actionId
string

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.

​
credentialId
string

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

​
id
string

Uniquely identifies the transaction in the system.

​
onChain
object

Information on the credential's current status on the blockchain, specifying its status on the specified network and related smart contract address.

Delete TemplateGet Credential by Credential ID