Credential Templates
Accepts the next image formats: image/jpeg, image/png, image/webp. Max size is: 5242880 bytes.
Claim-based access control: Issuer_Admin
, Issuer_User
Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!
nchain
Defines the credential type
emailCredential
PUT /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-templates/correlation/{correlationId}/credential/{credentialId}/background-cover-upload HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18
{
"image": "binary"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-07-07T16:05:33.558Z",
"updatedAt": "2025-07-07T16:05:33.558Z",
"correlationId": "nchain",
"credentialId": "emailCredential",
"isDefaultCoverImage": true,
"coverImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"mimeType": "image/jpeg",
"keyUrl": "text",
"filename": "text",
"type": "cover_image"
}
}
Fetch all the information related to the credential templates
Claim-based access control: Issuer_Admin
, Issuer_User
, Issuer_Auditor
Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!
nchain
Defines the credential type
emailCredential
GET /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-templates/correlation/{correlationId} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"credentials": [
{
"correlationId": "nchain",
"credentialId": "emailCredential",
"isDefaultCoverImage": true,
"coverImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"mimeType": "image/jpeg",
"keyUrl": "text",
"filename": "text",
"type": "cover_image"
},
"display": [
{
"name": "Email Credential",
"description": "Email Credential for Organisation",
"background_image": {
"url": "https://cloudfront.example.com/some-path/1/emailCredential"
}
}
],
"format": "jwt_vc_json",
"fieldOrder": [
"email"
],
"fields": {
"ANY_ADDITIONAL_PROPERTY": {
"value_type": "string",
"mandatory": true,
"display": [
{
"name": "text",
"locale": "text"
}
],
"format": "date",
"minLength": 1,
"maxLength": 1,
"pattern": "text",
"patternDescription": "text",
"enum": [
"text"
],
"minDate": "text",
"maxDate": "text",
"min": 1,
"max": 1
}
}
}
]
}
Deletes the credential template cover image and reverts back to the Issuer default one if exists else throws an error.
Delete credential template cover image.
Claim-based access control: Issuer_Admin
, Issuer_User
Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!
nchain
Defines the credential type
emailCredential
DELETE /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-templates/correlation/{correlationId}/credential/{credentialId}/cover-image HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*
No content