Skip to main content

Documentation

Everything you need to integrate with Iron Brick reference APIs.

Overview

The Iron Brick Developer Portal publishes the API contracts we implement on agency systems of record: case management, benefits intake, documents, records requests, events, and audit. Every API is described in OpenAPI 3.1, secured with OAuth 2.0, and available in a free sandbox that returns synthetic data.

Quickstart

Account, app, token, first call: about ten minutes.

Authentication

OAuth 2.0 client credentials, scopes, token validation, and agency identity federation.

Errors & rate limits

One error format, request IDs, quotas, and retry guidance.

MCP & AI agents

Give AI assistants governed, auditable access to records.

How the pieces fit

Systems of record stay where they are. Iron Brick system APIs unlock them, process APIs apply business rules, and experience APIs and MCP tools serve portals, caseworker apps, and AI assistants. The agency API gateway enforces identity, scopes, and rate limits, and every call is written to the audit log.

Conventions

  • JSON over HTTPS (TLS 1.2+), UTF-8, ISO 8601 timestamps in UTC.
  • Cursor pagination with cursor and limit; follow page.nextCursor until it is null.
  • Optimistic concurrency with If-Match on updates and Idempotency-Key on creates.
  • Every response carries X-Request-Id. Include it when you contact support.
  • Major version in the path (/v1); additive changes do not bump the version.