Skip to main content
POST
Request data access for a portfolio company

Authorizations

Authorization
string
header
required

Authorization: Bearer vein_sk_live_... or vein_sk_test_...

Body

application/json
company_id
string
required

The id of the portfolio company to request access to.

Example:

"startup_acme"

scopes
string[]
required

The scopes being requested.

Minimum array length: 1
Example:
purpose
string

Optional human-readable explanation sent to the company.

Response

Idempotent. An equivalent request already exists; the existing record is returned.

A data-access grant request submitted by an investor to a portfolio company.

id
string
required
Example:

"ar_01jxyz"

object
enum<string>
required
Available options:
access_request
company_id
string
required

The portfolio company this request targets.

Example:

"startup_acme"

requested_scopes
string[]
required
Example:
approved_scopes
string[]
required

Scopes the company approved; empty until status is approved.

Example:
status
enum<string>
required
Available options:
pending,
approved,
declined,
expired,
revoked
Example:

"pending"

created_at
string<date-time>
required
purpose
string | null

Optional human-readable explanation of why access is being requested.

expires_at
string<date-time>

When the grant expires.