Requirements data shape

Applies to 2.3.0 and later Updated 5 August 2026

Documents the JSON structure the credential Requirements tab reads and writes

Requirements data shape

A credential’s requirements are stored as a single JSON structure. The current format is version 2. The Kenii admin reads and writes this structure through the credential’s Requirements tab; this reference describes its shape for integrations and for anyone reading the stored data directly.

Structure

{
  "version": 2,
  "blocks": [
    {
      "title": "General Education",
      "credits": "15",
      "sections": [
        {
          "title": "Communications",
          "rule": "choose_one",
          "source": {
            "type": "courses",
            "courses": ["ENG-111", "ENG-112"]
          }
        },
        {
          "title": "Mathematics",
          "rule": "credits",
          "credits": "3",
          "source": {
            "type": "subjects",
            "prefixes": ["MAT"]
          }
        }
      ]
    }
  ]
}

Fields

Field	Type	Description
`version`	integer	Format version. Current value is `2`. Older data is upgraded on read.
`blocks`	array	Top-level groupings (for example “General Education”, “Major Requirements”).
`blocks[].title`	string	Block heading.
`blocks[].credits`	string	Total credits for the block, as displayed.
`blocks[].sections`	array	The requirement rows within a block.
`sections[].title`	string	Section heading.
`sections[].rule`	string	How the section is satisfied. One of `all`, `choose_one`, `credits`, `courses`, `groups`.
`sections[].credits`	string	Required credits, when `rule` is `credits`.
`sections[].source`	object	Where the section’s courses come from.
`source.type`	string	One of `courses` (an explicit list) or `subjects` (by course prefix).
`source.courses`	array	Course codes, when `source.type` is `courses`.
`source.prefixes`	array	Course prefixes (for example `MAT`), when `source.type` is `subjects`.

Rule values

Rule	Meaning
`all`	Every course in the section is required.
`choose_one`	The student completes one course from the section.
`credits`	The student completes a set number of credits from the section.
`courses`	The student completes a set number of courses from the section.
`groups`	The section is satisfied by completing a number of its groups (section rule only).

Prefixes used in a subjects source are validated against the course_prefix taxonomy.

How to build requirements with groups is the task guide for entering this data.
How requirement groups model a degree audit explains the model.

Requirements data shape

Requirements data shape

Structure

Fields

Rule values

Related