Create Credential Type with Name

PUT

v1-alpha1

credentials

types

{typeName}

curl --request PUT \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/types/{typeName} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Course completion",
  "description": "Describes the course completed and the assigned grade",
  "type": "object",
  "properties": {
    "credentialSubject": {
      "type": "object",
      "properties": {
        "course": {
          "type": "string"
        },
        "grade": {
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      },
      "required": [
        "course",
        "grade"
      ],
      "additionalProperties": false
    }
  }
}'

{
  "id": "crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate",
  "typeSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Course completion",
    "description": "Describes the course completed and the assigned grade",
    "type": "object",
    "properties": {
      "credentialSubject": {
        "type": "object",
        "properties": {
          "course": {
            "type": "string"
          },
          "grade": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "course",
          "grade"
        ],
        "additionalProperties": false
      }
    },
    "$id": "https://staging.crossmint.com/api/v1-alpha1/credentials/types/crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate"
  }
}

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

typeName

string

required

The name of the type.

Body

application/json

$schema

string

Example:

"https://json-schema.org/draft/2020-12/schema"

title

string

Example:

"Course completion"

description

string

Example:

"Describes the course completed and the assigned grade"

type

string

Example:

"object"

properties

object

properties.credentialSubject

object

Example:

{
  "type": "object",
  "properties": {
    "course": { "type": "string" },
    "grade": { "type": "string" },
    "id": { "type": "string" }
  },
  "required": ["course", "grade"],
  "additionalProperties": false
}

$schema

string

Example:

"https://json-schema.org/draft/2020-12/schema"

title

string

Example:

"Course completion"

description

string

Example:

"Describes the course completed and the assigned grade"

type

string

Example:

"object"

properties

object

properties.credentialSubject

object

Example:

{
  "type": "object",
  "properties": {
    "course": { "type": "string" },
    "grade": { "type": "string" },
    "id": { "type": "string" }
  },
  "required": ["course", "grade"],
  "additionalProperties": false
}

$id

string

URL for importing an existing type."

Example:

"https://raw.githubusercontent.com/decentralized-identity/credential-schemas/main/schemas/ExampleEntity/ExampleNameSchema.json"

Response

200

application/json

Success.

string

Example:

"crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate"

typeSchema

object

typeSchema.$schema

string

Example:

"https://json-schema.org/draft/2020-12/schema"

typeSchema.title

string

Example:

"Course completion"

typeSchema.description

string

Example:

"Describes the course completed and the assigned grade"

typeSchema.type

string

Example:

"object"

typeSchema.properties

object

typeSchema.properties.credentialSubject

object

Example:

{
  "type": "object",
  "properties": {
    "course": { "type": "string" },
    "grade": { "type": "string" },
    "id": { "type": "string" }
  },
  "required": ["course", "grade"],
  "additionalProperties": false
}

typeSchema.$id

string

Example:

"https://staging.crossmint.com/api/v1-alpha1/credentials/types/crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate"

Was this page helpful?

Create Credential Type Get a Credential Type

curl --request PUT \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/types/{typeName} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Course completion",
  "description": "Describes the course completed and the assigned grade",
  "type": "object",
  "properties": {
    "credentialSubject": {
      "type": "object",
      "properties": {
        "course": {
          "type": "string"
        },
        "grade": {
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      },
      "required": [
        "course",
        "grade"
      ],
      "additionalProperties": false
    }
  }
}'

{
  "id": "crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate",
  "typeSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Course completion",
    "description": "Describes the course completed and the assigned grade",
    "type": "object",
    "properties": {
      "credentialSubject": {
        "type": "object",
        "properties": {
          "course": {
            "type": "string"
          },
          "grade": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "course",
          "grade"
        ],
        "additionalProperties": false
      }
    },
    "$id": "https://staging.crossmint.com/api/v1-alpha1/credentials/types/crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate"
  }
}

API Reference

Wallets

NFTs

IP

NFT Collections

NFT Templates

Verifiable Credentials

Verifiable Credential Types

Headless Checkout

Action Status

Admin

Subscriptions

Create Credential Type with Name

Authorizations

Path Parameters

Body

Response