Clearway Documentation
  • Home
  • Guides
  • Merchant API
  • Investor Read API
API integration
Getting startedAuthenticationAPI keys and scopesRequest headersIdempotencyErrorsWebhook verificationWebhook eventsOrders and revenueSubscriptionsCheckout integrationDashboard vs APIRate limits
Investor / LP
Investor Read API
Merchant dashboard
Getting startedPayment links & chargesPayment widgetClearway ElementsCheckout & branding
powered by Zudoku
Guides

Investor Read API

Investor Read API

LP fund models and diligence tools pull certified metrics through the Investor Read API on {docsEnv.apiBaseUrl}.

Hosted catalog

Interactive OpenAPI (Zudoku): Investor Read API reference.

Schema download is enabled from that page. Source of truth in the monorepo: docs/investor/read-api/openapi.yaml (synced into the docs package at build time).

Authenticate

  1. Open the investor portal governance section and mint a scoped clwy_inv_… key.
  2. Call routes with Authorization: Bearer <key> (or the gateway’s investor key header).
  3. Prefer Power Query templates under docs/investor/read-api/powerquery/ for Excel / fund-model workbooks.

Public receipt verify

Auditors can confirm a pull without the secret:

TerminalCode
curl -sS -X POST "{docsEnv.apiBaseUrl}/GET_INVESTOR_VERIFY_READ_RECEIPT" \ -H "Content-Type: application/json" \ -d '{"receiptId":"<uuid-from-certification>"}'

Returns hashes and timestamps only — no PII. See the full operator guide: READ-API.md.

Last modified on July 22, 2026
Rate limitsGetting started
On this page
  • Hosted catalog
  • Authenticate
  • Public receipt verify