API Reference

The SFRS API provides endpoints for validating SFRS documents, converting between formats, packaging canonical filings, and accessing schema information.

Base URL

https://api.sureshake.org

Available Endpoints

Validation

• POST /api/v1/validate - Validate an SFRS document against schema and business rules
• GET /api/v1/validate/rules - Get available validation rules

Conversion

• POST /api/v1/convert/to-ixbrl - Convert SFRS to iXBRL format
• POST /api/v1/convert/to-xbrl - Convert canonical SFRS v2 to XBRL
• POST /api/v1/convert/from-xbrl - Convert XBRL to SFRS format
• POST /api/v1/package - Build a profile-driven canonical filing package
• GET /api/v1/convert/formats - Get supported conversion formats

Model Versions

The API currently supports two model surfaces:

• v1 Legacy statement-shaped SFRS documents.
• v2 Canonical fact-centric filings.

New integrations should prefer v2.

Schemas

• GET /api/v1/schemas - Get available SFRS schemas

Health

• GET /health - Health check endpoint

Authentication

Currently, the SFRS API is publicly accessible without authentication for development purposes.

Response Format

All API responses are returned in JSON format with appropriate HTTP status codes.