Learning and Development

Field descriptions

Copy
{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "credential_type": { "type": "string" }, // (Required) Must be "microcredential"
  "document_type": { "type": "string" }, // (Required) Must be one of "pdf", "open_cert", or "none"
  "data": { // { "type": "object" }, (Required)
    "credential": { // { "type": "object" }, (Required)
      "full_name": { "type": "string" }, // (Required)
      "issuer_name": { "type": "string" }, // (Required)
      "microcredential_name": { "type": "string" }, // (Required)
      "issue_date": { "type": "string" }, // (Required) Date format: "YYYY-MM-DD"
      "expiry_date": { "type": "string" }, // (Optional) Date format: "YYYY-MM-DD"
      "assessment_result": { "type": ["string", null] } // (Optional) Text description
    },
    "document": { "type": "string" }, // (Optional) Depending on the supplied document_type, either a URL pointing to a PDF document, the content of an OpenCert document, or null if not applicable.
  }
}

Sample payload

With PDF document

Copy
{
  "id": "1",
  "credential_type": "microcredential",
  "document_type": "pdf",
  "data": {
    "document": "https://example.com/1234",
    "credential": {
      "full_name": "John Doe",
      "issuer_name": "ExampleProvider",
      "microcredential_name": "Skill Test #1",
      "issue_date": "2024-08-31",
      "expiry_date": "2026-08-31",
      "assessment_result": "85%"
    }
  }
}

With OpenCert document

Copy
{
  "id": "some_external_id",
  "credential_type": "microcredential",
  "document_type": "open_cert",
  "data": {
    "document": "{\"version\":\"https://schema.openattestation.com/2.0/schema.json\",\"schema\":\"https://raw.githubusercontent.com/OpenCerts/open-certificate/master/schema/transcripts/2.0/schema.json\"}",
    "credential": {
      "full_name": "John Doe",
      "issuer_name": "ExampleProvider",
      "microcredential_name": "Skill Test #2",
      "issue_date": "2024-08-31",
      "expiry_date": "2026-08-31",
      "assessment_result": "Pass"
    }
  }
}

With no document

Copy
{
  "id": "1",
  "credential_type": "microcredential",
  "document_type": "none",
  "data": {
    "document": null,
    "credential": {
      "full_name": "John Doe",
      "issuer_name": "ExampleProvider",
      "microcredential_name": "Skill Test #3",
      "issue_date": "2024-08-31",
      "expiry_date": "2026-08-31"
    }
  }
}