Skip to main content
POST
/
v1-alpha1
/
credentials
/
types
Create Credential Type
curl --request POST \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/types \
  --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
    }
  }
}
'
import requests

url = "https://staging.crossmint.com/api/v1-alpha1/credentials/types"

payload = {
    "$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
        } }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    $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
      }
    }
  })
};

fetch('https://staging.crossmint.com/api/v1-alpha1/credentials/types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.crossmint.com/api/v1-alpha1/credentials/types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$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
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/v1-alpha1/credentials/types"

	payload := strings.NewReader("{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"Course completion\",\n  \"description\": \"Describes the course completed and the assigned grade\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"credentialSubject\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"course\": {\n          \"type\": \"string\"\n        },\n        \"grade\": {\n          \"type\": \"string\"\n        },\n        \"id\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"course\",\n        \"grade\"\n      ],\n      \"additionalProperties\": false\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/v1-alpha1/credentials/types")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"Course completion\",\n  \"description\": \"Describes the course completed and the assigned grade\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"credentialSubject\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"course\": {\n          \"type\": \"string\"\n        },\n        \"grade\": {\n          \"type\": \"string\"\n        },\n        \"id\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"course\",\n        \"grade\"\n      ],\n      \"additionalProperties\": false\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/v1-alpha1/credentials/types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"title\": \"Course completion\",\n  \"description\": \"Describes the course completed and the assigned grade\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"credentialSubject\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"course\": {\n          \"type\": \"string\"\n        },\n        \"grade\": {\n          \"type\": \"string\"\n        },\n        \"id\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"course\",\n        \"grade\"\n      ],\n      \"additionalProperties\": false\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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.

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

Response

Success.

​
id
string
Example:

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

​
typeSchema
object