This guide provides a comprehensive overview of the Reach Reporting integration. It is intended for both technical teams and business stakeholders, outlining:
- What the integration enables for partners and their customers
- How the integration works at a high level
- The full Reach API specification for implementation
By covering both technical and business perspectives, this guide ensures all stakeholders understand the integration and its benefits.
The Reach API Specification allows your platform to expose structured financial data in a lightweight, standardized format.
Once integrated, your customers will have full access to Reach’s dashboards, reporting, forecasting, and AI-driven insights — all powered by your data.
This approach provides a scalable, consistent experience for both partners and customers, without requiring custom development per client.
For a concise overview of the benefits, see the Benefits Summary document.
- User adds the connection
- Partner hosts the REST API implementing the Reach Spec
- Reach initiates secure API calls to fetch data
- Data is stored, mapped, and visualized within Reach
- Customers interact with their synced data through the Reach platform
Begin by reviewing the Reach API Specification.
It defines the required endpoints, request and response formats, and expected behavior needed to integrate with Reach.
Contact Arthur at arthur@reachreporting.com to request approval. Approval typically requires providing basic company information, your intended use case, and agreeing to the partnership terms.
Build the API using your preferred language and framework.
The specification is language-agnostic and requires only a small set of read-only endpoints.
Because the Reach API is defined using the OpenAPI (formerly Swagger) standard, you can use common tooling to speed up development and testing, such as:
- OpenAPI Generator or Swagger Codegen to scaffold servers or client SDKs
- Linters and schema validators to verify conformance
- Swagger UI to view and interact with the API
These tools are optional but can significantly reduce development time and catch issues early.
Deploy the API to a publicly accessible environment.
Authentication is handled using OAuth 2.0. Reach will include a customer-specific access token in theAuthorization: Bearer <token> header with every request.
Once your API is live and internally tested, provide Reach with your API’s base URL along with the OAuth 2.0 client credentials (client ID and client secret).
The partner team is responsible for performing full testing of their API to ensure it meets the specification and behaves correctly in all scenarios.
Once the API is ready, Reach will perform basic validation checks to confirm that the API is reachable and responding as expected.
For full implementation details, see the Implementation Process document.