# Vein Docs ## Docs - [Overview](https://docs.vein.finance/overview.md): What Vein is, and how reporting works between companies and their investors. - [Guides](https://docs.vein.finance/guides/overview.md): Step-by-step walkthroughs of every flow companies and investors run in Vein. - [Read your dashboard](https://docs.vein.finance/guides/your-dashboard.md): The screen you land on, showing current metrics, where each figure came from, and how overdue your next report is. - [Connect a data source](https://docs.vein.finance/guides/connect-a-data-source.md): Link a bank, ledger, payroll, or payments provider so your metrics update on their own. - [Build and send a report](https://docs.vein.finance/guides/build-and-send-a-report.md): Assemble a report from blocks and deliver it to your investors. - [Respond to a report request](https://docs.vein.finance/guides/respond-to-a-report-request.md): Fill an investor's request for specific metrics over a specific period. - [Store documents in the Vault](https://docs.vein.finance/guides/use-the-vault.md): Keep the documents investors ask for in one place, ready to attach to a report. - [Share a data room](https://docs.vein.finance/guides/share-a-data-room.md): Publish a password-protected link to a report you have already sent. - [Approve or deny data access](https://docs.vein.finance/guides/approve-data-access.md): Decide whether an investor gets ongoing access to your data, and to which parts. - [Your portfolio](https://docs.vein.finance/guides/view-your-portfolio.md): See every company you have invested in, and drill into any one of them. - [Portfolio intelligence](https://docs.vein.finance/guides/portfolio-intelligence.md): Read across the whole portfolio, with aggregated metrics, qualitative updates, and AI summaries. - [Read and request reports](https://docs.vein.finance/guides/request-a-report.md): What arrives when a company reports, how to read it, and how to ask for what is missing. - [Schedules and request templates](https://docs.vein.finance/guides/reuse-request-templates.md): Stop rebuilding the same request. Save it as a template, or put it on a schedule. - [Request data access](https://docs.vein.finance/guides/request-data-access.md): Move from one-off reports to an ongoing read of a company's data. - [Roles and permissions](https://docs.vein.finance/guides/roles-and-permissions.md): What each role can do, and why a control you expected is not on your screen. - [Notifications and email](https://docs.vein.finance/guides/notifications.md): Where Vein tells you something happened, and how to change what reaches your inbox. - [Your account and sign-in](https://docs.vein.finance/guides/account-and-sign-in.md): Signing in, resetting a password you have forgotten, and the display preferences stored on your device. - [Quickstart](https://docs.vein.finance/quickstart.md): Make your first authenticated Vein API call in under 5 minutes. - [Create an API key](https://docs.vein.finance/api-keys.md): Issue a key for the Vein API from Settings, choose its scopes, and revoke it when you are done. - [Authentication](https://docs.vein.finance/authentication.md): How Vein API keys work. - [List access requests](https://docs.vein.finance/api-reference/list-access-requests.md): Returns all data-access grant requests submitted by the API key's company in a single (non-paginated) list. Phase 1 does not implement cursor pagination; the full list is always returned with `has_more: false` and `next_cursor: null`. Filter by `status` to narrow results. Requires a valid API key (n… - [Request data access for a portfolio company](https://docs.vein.finance/api-reference/request-data-access-for-a-portfolio-company.md): Submits a data-access grant request to a portfolio company. The company must approve the request before financial endpoints (`metrics:read`) will return data. Only one live request per company is allowed. If a live (`pending` or `approved`) request already exists for this company and already covers… - [Health/auth smoke check](https://docs.vein.finance/api-reference/healthauth-smoke-check.md): Returns 204 if the API key authenticated successfully. - [List portfolio companies](https://docs.vein.finance/api-reference/list-portfolio-companies.md): Lists the portfolio companies accessible to the API key's company. Requires the `companies:read` scope. - [List a company's metrics](https://docs.vein.finance/api-reference/list-a-companys-metrics.md): Returns the latest value of every available metric for the portfolio company `id`, each with full source attribution. Requires the `metrics:read` scope and an approved data-access grant from the company. The company must belong to the API key's portfolio; otherwise the API returns 404 with code `com… - [Get a single metric](https://docs.vein.finance/api-reference/get-a-single-metric.md): Returns the latest value of a single metric `key` (for example `cash_balance`) for the portfolio company `id`. Requires the `metrics:read` scope and an approved data-access grant from the company. Returns 404 with code `company_not_found` when the company is outside the key's portfolio, or `metric_n… - [Get metric history for a company](https://docs.vein.finance/api-reference/get-metric-history-for-a-company.md): Time series of one metric for one company (oldest first). Returns an empty list if the company is accessible but the key has no data. Requires the `metrics:read` scope and an approved data-access grant from the company. Returns 404 with code `company_not_found` when the company is outside the key's… - [List a company's financial accounts](https://docs.vein.finance/api-reference/list-a-companys-financial-accounts.md): A company's financial accounts (balances). Requires the `accounts:read` scope and an approved data-access grant from the company. The company must belong to the API key's portfolio; otherwise the API returns 404 with code `company_not_found` (it does not disclose whether a company outside the portfo… - [List a company's connected data sources](https://docs.vein.finance/api-reference/list-a-companys-connected-data-sources.md): A company's connected data sources and their sync status. Credentials are never returned. Requires the `sources:read` scope and an approved data-access grant from the company. The company must belong to the API key's portfolio; otherwise the API returns 404 with code `company_not_found` (it does not… - [List metrics across portfolio](https://docs.vein.finance/api-reference/list-metrics-across-portfolio.md): Latest value of the requested metric(s) across every portfolio company that has granted you `metrics:read`. Companies you have not been granted access to are silently omitted. Requires the `metrics:read` scope; the only possible 403 code is `insufficient_scope`, and there is no per-company 403 on th… - [FAQ](https://docs.vein.finance/support/faq.md): The questions that come up most often, answered. - [Contact us](https://docs.vein.finance/support/contact.md): Send the Vein team a message. ## OpenAPI Specs - [openapi](https://docs.vein.finance/openapi.yaml)