Create or import a type with a given name. This is how you define a custom credential schema.
API scope required credentials.create
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"
}
}
Key obtained from the Crossmint developer console, reflecting the API scope granted.
The name of the type.
Success.
The response is of type object
.
Was this page helpful?
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"
}
}