The Basiq OpenAPI specification provides a complete, machine-readable definition of all API endpoints, request/response schemas, and authentication flows.
It is the canonical source of truth for building and validating integrations with Basiq APIs.
Domain specifications
For faster access and better AI/tooling performance, the API is also split into domain-level specs:
Connect → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/connect.json
Enrich → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/enrich.json
Insights → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/insights.json
Identity → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/identity.json
Reporting → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/reporting.json
Webhooks → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/webhooks.json
Platform → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/platform.json
Affordability → https://raw.githubusercontent.com/basiqio-oss/Basiq-docs/refs/heads/v3.0/reference/affordability.json
What this enables
With the OpenAPI spec, you can:
- Generate client SDKs automatically
- Validate API requests and responses
- Explore full endpoint definitions in tooling
- Build integrations with strict type safety
- Support AI-driven code generation workflows
Recommended usage
For best developer and AI experience:
- Use MCP Server for live API interaction and debugging
- Use OpenAPI for schema definitions and code generation
- Use LLM Resources for lightweight documentation discovery
Versioning
- Current version: v3.0
- Domain specs follow the same versioning as the API surface
- Breaking changes are introduced via major version updates
Related
- MCP Server → https://api.basiq.io/mcp
- LLM Resources → https://api.basiq.io/llms.txt