Credential Templates

PreviousCredential Offers NextClaim

Deletes the credential template cover image and reverts back to the Issuer default one if exists else throws an error.

delete

Delete credential template cover image.

Claim-based access control: Issuer_Admin, Issuer_User

Authorizations

Path parameters

correlationIdstringRequired

Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!

Example: nchain

credentialIdstringRequired

Defines the credential type

Example: emailCredential

Responses

204

Successfully deleted

400

Invalid request params.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

500

Internal server error.

delete

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

Fetch credential templates

get

Fetch all the information related to the credential templates

Claim-based access control: Issuer_Admin, Issuer_User, Issuer_Auditor

Authorizations

Path parameters

correlationIdstringRequired

Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!

Example: nchain

Query parameters

credentialIdstringOptional

Defines the credential type

Example: emailCredential

Responses

200Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

500

Internal server error.

get

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
        }
      }
    }
  ]
}

Upload credential template background cover image.

put

Accepts the next image formats: image/jpeg, image/png, image/webp. Max size is: 5242880 bytes.

Claim-based access control: Issuer_Admin, Issuer_User

Authorizations

Path parameters

correlationIdstringRequired

Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!

Example: nchain

credentialIdstringRequired

Defines the credential type

Example: emailCredential

Body

imagestring · binaryOptional

Responses

200Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

413

Image exceeds the allowed size.

415

Unsupported media type.

500

Internal server error.

put

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-06-20T03:01:54.663Z",
  "updatedAt": "2025-06-20T03:01:54.663Z",
  "correlationId": "nchain",
  "credentialId": "emailCredential",
  "isDefaultCoverImage": true,
  "coverImage": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "mimeType": "image/jpeg",
    "keyUrl": "text",
    "filename": "text",
    "type": "cover_image"
  }
}