Get Regulation Details

GET /api/v1/regulations/{id}

Returns a single Regulation Detail Object — the document’s metadata, total size, table of contents, and category-specific attributes. The document body text is not returned here; use the Get Regulation Content to fetch text by offset.

Parameters

Name	In	Type	Description
id	path	string	Stable document id from a browse result, or an externalId slug (e.g. 31-cfr-1020-320). Both forms are accepted.

Response

{
  "id": "cmdoc_01HXZ3K4M7QR9VP2N8WYJF5GTB",
  "category": "regulation",
  "title": "Suspicious Activity Report Filing Requirements for Banks",
  "authorities": ["fincen"],
  "jurisdictions": ["us-federal"],
  "description": "Part of the Bank Secrecy Act / Anti-Money Laundering (BSA/AML) framework...",
  "updatedAt": "2026-04-09T00:00:00Z",
  "sourceUrl": "https://www.ecfr.gov/current/title-31/...",
  "totalBytes": 28400,
  "tableOfContents": {
    "entries": [
      { "id": "toc_a", "title": "(a) General", "level": 1, "startOffset": 0 },
      { "id": "toc_a_1", "title": "(1) Filing obligation", "level": 2, "startOffset": 120, "parentId": "toc_a" },
      { "id": "toc_b", "title": "(b) Filing procedures", "level": 1, "startOffset": 4200 }
    ]
  },
  "attributes": {
    "category": "regulation",
    "citation": "31 CFR 1020.320",
    "sourceUrl": "https://www.ecfr.gov/current/title-31/...",
    "cfrTitle": 31,
    "cfrPart": 1020,
    "cfrSection": "1020.320",
    "effectiveDate": "2011-03-01",
    "lastAmendedDate": "2023-08-15"
  }
}

Response Fields

The response is a Regulation Detail Object — all fields from the Regulation Summary Object plus:

Field	Type	Description
totalBytes	integer	Total byte count of the full document text
tableOfContents	object	{ entries: TOCEntry[] } — flat list of heading entries with byte offsets
attributes	object or null	Per-category structured metadata. Shape depends on category. null when attributes are not available. See Regulation Detail Object.

Table of Contents Entries

Each TOC entry describes one heading in the document:

Field	Type	Description
id	string	Stable id for the TOC entry
title	string	Heading text as it appears in the document
level	integer	Heading depth (1 is top-level)
startOffset	integer	Byte offset where this section begins in the full UTF-8 document text
parentId	string	Optional id of the enclosing entry, when the TOC is hierarchical

Retrieving Document Text

Document text is served by the Get Regulation Content. Fetch by offset/limit:

curl "https://api.midlyr.com/api/v1/regulations/cmdoc_01HXZ3K.../content?offset=0&limit=40000"