API Overview

The MidLyr API provides programmatic access to regulatory source retrieval and compliance analysis for banks and fintechs. The Regulations API exposes the full body of compliance sources a US bank or fintech must follow; the Analysis API evaluates submitted content for regulatory risk.

Base URL

https://api.midlyr.com/api/v1

Endpoints

Endpoint	Method	Purpose
/regulations	GET	Search the compliance-source catalog with optional natural-language query and filters
/regulations/{id}	GET	Fetch a single document’s metadata, total size, and table of contents
/regulations/{id}/content	GET	Fetch document text by character offset, TOC section, or cursor
/analysis/screen	POST	Submit an asynchronous compliance-screening analysis job
/jobs/{id}	GET	Retrieve async job status and typed result when available

Versioning

• Version is in the path: /api/v1/...
• Additive changes are allowed in v1: new optional query parameters, new response fields, new enum values, and new category/authorities/jurisdictions entries
• Breaking changes require a new version: removing fields, renaming fields, changing field types, or changing the meaning of existing enum values

IDs

Document IDs are ULIDs, for example 01HXZ3K4M7QR9VP2N8WYJF5GTB. They are stable, unique, and never reused in v1.

Timestamps

• Timestamps are ISO 8601 UTC strings: 2026-04-11T00:00:00Z
• Calendar dates are ISO 8601 date strings: 2024-09-15
• v1 returns English content only

Provenance

Every document carries enough source provenance for verification without a follow-up call:

• id — stable identifier
• title — human-readable name
• sourceUrl — link to the upstream source