API reference

Base URL

• /api/v1 Relative to your workspace API host

Endpoints

• get/investors

  List investors

  Required scope: `investors:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • kind (query)

• post/investors

  Create an investor

  Required scope: `investors:write`. Accepts an Idempotency-Key header.

• get/investors/{id}

  Get one of investors

  Required scope: `investors:read` (or the matching :write scope).

  • id (path, required)

• get/entities

  List investing entities

  Required scope: `entities:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • kind (query)

• get/entities/{id}

  Get one of investing entities

  Required scope: `entities:read` (or the matching :write scope).

  • id (path, required)

• get/funds

  List funds

  Required scope: `funds:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)

• get/funds/{id}

  Get one of funds

  Required scope: `funds:read` (or the matching :write scope).

  • id (path, required)

• get/commitments

  List commitments

  Required scope: `commitments:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • investor_entity_id (query)
  • status (query)

• post/commitments

  Record an accepted commitment (creates the capital account)

  Required scope: `commitments:write`. Accepts an Idempotency-Key header.

• get/commitments/{id}

  Get one of commitments

  Required scope: `commitments:read` (or the matching :write scope).

  • id (path, required)

• get/capital-accounts

  List capital accounts

  Required scope: `capital_accounts:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • investor_entity_id (query)

• get/capital-accounts/{id}

  Get one of capital accounts

  Required scope: `capital_accounts:read` (or the matching :write scope).

  • id (path, required)

• get/transactions

  List investor transactions

  Required scope: `transactions:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • capital_account_id (query)
  • kind (query)

• get/transactions/{id}

  Get one of investor transactions

  Required scope: `transactions:read` (or the matching :write scope).

  • id (path, required)

• get/capital-calls

  List capital calls

  Required scope: `capital_calls:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • status (query)

• get/capital-calls/{id}

  Get one of capital calls

  Required scope: `capital_calls:read` (or the matching :write scope).

  • id (path, required)

• get/distributions

  List distributions

  Required scope: `distributions:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • status (query)

• get/distributions/{id}

  Get one of distributions

  Required scope: `distributions:read` (or the matching :write scope).

  • id (path, required)

• get/documents

  List documents (metadata only)

  Required scope: `documents:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • type (query)

• post/documents

  Create a document record and get an upload target

  Required scope: `documents:write`. Accepts an Idempotency-Key header.

• get/documents/{id}

  Get one of documents (metadata only)

  Required scope: `documents:read` (or the matching :write scope).

  • id (path, required)

• get/statements

  List published capital account statements

  Required scope: `statements:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • capital_account_id (query)

• get/statements/{id}

  Get one of published capital account statements

  Required scope: `statements:read` (or the matching :write scope).

  • id (path, required)

• get/envelopes

  List e-sign envelopes (status)

  Required scope: `envelopes:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • status (query)

• get/envelopes/{id}

  Get one of e-sign envelopes (status)

  Required scope: `envelopes:read` (or the matching :write scope).

  • id (path, required)

• get/tax-documents

  List tax documents

  Required scope: `tax_documents:read` (or the matching :write scope).

  • limit (query)
  • cursor (query)
  • fund_id (query)
  • investor_entity_id (query)
  • tax_year (query)

• get/tax-documents/{id}

  Get one of tax documents

  Required scope: `tax_documents:read` (or the matching :write scope).

  • id (path, required)

• post/documents/{id}/complete

  Tell us the upload finished: the file is scanned now (the document is published separately, once the scan is clean)

  Required scope: `documents:write`. Accepts an Idempotency-Key header.

  • id (path, required)

• post/documents/{id}/publish

  Publish a document to its audience; only a scanned, sanitized file (scan_status READY) can be published

  Required scope: `documents:write`. Accepts an Idempotency-Key header.

  • id (path, required)

• get/webhooks

  List webhook endpoints

  Required scope: `webhooks:manage`.

• post/webhooks

  Create a webhook endpoint (secret shown once)

  Required scope: `webhooks:manage`. Accepts an Idempotency-Key header.

• delete/webhooks/{id}

  Delete a webhook endpoint

  Required scope: `webhooks:manage`. Accepts an Idempotency-Key header.

  • id (path, required)

Webhook events

Events delivered to your endpoint. See the webhooks guide for signature verification and retries.

• investor.created

  investor.created

• investor.updated

  investor.updated

• subscription.status_changed

  subscription.status_changed

• commitment.accepted

  commitment.accepted

• capital_call.issued

  capital_call.issued

• capital_call.item_paid

  capital_call.item_paid

• capital_call.closed

  capital_call.closed

• distribution.approved

  distribution.approved

• distribution.paid

  distribution.paid

• payment.status_changed

  payment.status_changed

• document.published

  document.published

• document.viewed

  document.viewed

• statement.published

  statement.published

• envelope.completed

  envelope.completed

• envelope.declined

  envelope.declined

• period.closed

  period.closed

• nav.published

  nav.published

• tax_document.delivered

  tax_document.delivered

• bank_account.changed

  bank_account.changed