Skip to main content

Overview

Requirements are structured compliance obligations extracted from regulation articles. Each requirement is linked back to its source article and paragraph, categorised by type, and optionally includes a compliance deadline and stakeholder roles.

Methods

list()

Returns a page of requirements, optionally filtered to a single framework.
Parameters
ParameterTypeDefaultDescription
frameworkSlugstringFilter to a specific framework
pagenumber1Page number
perPagenumber20Items per page (1–100)
Returns Promise<Page<Requirement>>

iter()

Iterate over requirements, optionally filtered to a framework.
Parameters — same options as list() (except page, which is managed internally). Returns AsyncGenerator<Requirement>

Model

Requirement

FieldTypeDescription
idnumberInternal numeric ID
frameworkSlugstringParent framework slug
articleNumbernumberSource article number
paragraphRefstring | nullSource paragraph reference, e.g. "1", "2a"
paragraphContentstring | nullFull text of the source paragraph
requirementTextstringExtracted requirement obligation text
requirementTypestringCategory, e.g. "obligation", "prohibition", "right"
complianceDeadlinestring | nullISO 8601 deadline date, if applicable
linkedArticleNumbersnumber[]Related article numbers
stakeholderRolesstring[]Roles this requirement applies to, e.g. ["controller", "processor"]
tagsTag[]Tags applied to the requirement
createdAtstringISO 8601 creation timestamp

Example: build a compliance checklist

Requirements are extracted from article paragraphs through automated analysis. Cross-check against the source article text — accessible via client.articles.get() — for authoritative wording.