RegGenome

The RegGenome API exposes regulatory and standards documents — frameworks like NIST CSF 2.0, sector regulations, and other authoritative cybersecurity texts — along with the signposts and actionable items extracted from them. All /api/v1/reggenome endpoints require a SAMS token and the RegGenome product entitlement.

List RegGenome documents

GET /api/v1/reggenome

Name
search
Type
string
Description
Filter by document title (case-insensitive).
Name
publisher
Type
string
Description
Filter by publisher name (e.g. NIST).
Name
doctype
Type
string
Description
Filter by document type (e.g. Framework, Regulation).
Name
page
Type
integer
Description
Page number (default: 1).
Name
limit
Type
integer
Description
Items per page (default: 100, max: 150).

Response

{
  "documents": [
    {
      "id": "doc-uuid",
      "documentId": "NIST-CSF-2.0",
      "title": "NIST Cybersecurity Framework 2.0",
      "publisher": "NIST",
      "publisherId": "nist",
      "doctype": "Framework",
      "published": "2024-02-26",
      "cyberScore": 8.5,
      "jurisdiction": "US",
      "signpostCount": 45,
      "actionableItemCount": 128
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "total": 25,
    "totalPages": 1
  }
}

Get a RegGenome document

GET /api/v1/reggenome/{documentId}

Returns the full document record — metadata, every signpost, and every actionable item.

Response

{
  "id": "doc-uuid",
  "documentId": "NIST-CSF-2.0",
  "title": "NIST Cybersecurity Framework 2.0",
  "publisher": "NIST",
  "publisherId": "nist",
  "doctype": "Framework",
  "published": "2024-02-26",
  "cyberScore": 8.5,
  "jurisdiction": "US",
  "sectorLevel1": "Critical Infrastructure",
  "sectorLevel2": "Cybersecurity",
  "sectorLevel3": "Framework",
  "sectorLevel4": "Risk Management",
  "authoritative": true,
  "sourceUrl": "https://www.nist.gov/cyberframework",
  "restriction": null,
  "signposts": [
    {
      "tag": "GOVERN",
      "page": 15,
      "inferenceText": "Establish governance structures...",
      "nistCsf": [
        {
          "csfFunction": "Govern",
          "csfCategory": "GV.RO",
          "csfCategoryName": "Roles, Responsibilities, and Authorities"
        }
      ]
    }
  ],
  "actionableItems": [
    {
      "actionId": "ACT-001",
      "text": "Implement and maintain organizational governance...",
      "originText": "Original text from the source document",
      "sourceReference": "Section 2.1.1",
      "pageIndex": 15,
      "obligation": true,
      "psc": false,
      "specification": true,
      "timingOrTrigger": true,
      "applicationConditions": "When X occurs",
      "exemptConditions": "If Y applies"
    }
  ]
}

Returns 404 if the documentId is not found.

Download a RegGenome document

GET /api/v1/reggenome/{documentId}/download

Name
documentId
Type
string
Description
RegGenome document ID.
Name
format
Type
string
Description
Export format: json (default), csv, or xml.

{
  "documentId": "NIST-CSF-2.0",
  "title": "NIST Cybersecurity Framework 2.0",
  "signposts": [...],
  "actionableItems": [...]
}