Learning and Development (Microcredential)

Field descriptions

Important: Please ensure the attached document file (if present) is in PDF, PNG, JPG, or OpenCert format.

{
  "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", "png", "jpg", "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
      "partner_chain": { "type": ["array", "null"] } // (Optional unless otherwise specified) Array of objects to specifiy partner institutions, e.g. [{ "name": "Partner Organization" }]
    },
    "document": { "type": "string" }, // (Optional) Depending on the supplied document_type, either a URL pointing to a PDF/JPG/PNG document, the content of an OpenCert document, or null if not applicable.
  }
}

Leveraging Learning and Development fields

Partner chain

The partner_chain field captures intermediate relationships in multi-layered partner hierarchies that aren't represented elsewhere in the integration. It improves the granularity of analytics SEEK Pass can provide to you.Click here for more details.

Sample payloads

With PDF document

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "credential_type": "microcredential",
  "document_type": "pdf",
  "data": {
    "document": "https://example.com/certificate.pdf",
    "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

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "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

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "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"
    }
  }
}

With `partner_chain`

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "credential_type": "microcredential",
  "document_type": "pdf",
  "data": {
    "document": "https://example.com/certificate.pdf",
    "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%",
      "partner_chain": [
        { "name": "Partner Organization" }
      ]
    }
  }
}

Previous: English Proficiency

Next: Right to Work