SDKs · Node
Type reference (Node)
TypeScript type signatures for every Matter resource. Generated from the canonical OpenAPI spec.
Last updated
Every interface here ships in @mattermode/node as a .d.ts declaration generated
from the same OpenAPI spec that drives the API server. Use these as the contract;
the runtime payloads are guaranteed to validate against them.
Resources are alphabetical by typed-ID prefix. Each interface lists every property — required first, optional with ?. Nested types resolve to their named interface; descend the table of contents to find them.
Account
Typed-ID prefix acct_. The API customer. Top-level identity owning tokens, portfolios, and entities.
/** The API customer. Top-level identity owning tokens, portfolios, and entities. */
export interface Account {
id: string;
object: "account";
legal_name: string;
billing_email?: string;
billing_address?: Address;
default_jurisdiction?: Jurisdiction;
default_registered_agent_provider?: "matter" | "external";
default_signing_method?: "matter_native" | "docusign" | "adobe_sign" | "dropbox_sign";
tier_max?: number;
active_agent_policy_id?: unknown;
portfolio_ids?: Array<string>;
primary_principal_user_id?: unknown;
soc2_attestation_status?: "not_started" | "in_progress" | "attested" | "lapsed";
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}AgentPolicy
Typed-ID prefix pol_. Versioned governance record of what agent tokens may do. Authorizations are
/** Versioned governance record of what agent tokens may do. Authorizations are */
export interface AgentPolicy {
id: string;
object: "agent_policy";
name: string;
tier_max: number;
version: number;
active: boolean;
allowed_endpoints?: Array<string>;
denied_endpoints?: Array<string>;
resources?: Array<string>;
conditions?: Record<string, unknown>;
require_human_signature_for?: Array<string>;
standing_acknowledgements?: Array<AcknowledgementSlug>;
spend_limit_per_period?: { amount?: MonetaryAmount; period?: "hour" | "day" | "week" | "month" | "quarter"; consumed_in_period?: MonetaryAmount; reset_at?: number };
escalation_email?: string;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}AuditEntry
Typed-ID prefix aud_. Immutable record of a state-changing action. One per transition. Signature-producing
/** Immutable record of a state-changing action. One per transition. Signature-producing */
export interface AuditEntry {
id: string;
object: "audit_entry";
entity_id: unknown;
actor: { type: "user" | "agent" | "platform"; id: string };
action: string;
before?: unknown;
after?: Record<string, unknown>;
request_id?: string;
ip?: string;
occurred_at: number;
livemode: boolean;
}Authorization
Typed-ID prefix azn_. First-class async pause. When a tier-3 action requires human signature, the API
/** First-class async pause. When a tier-3 action requires human signature, the API */
export interface Authorization {
id: string;
object: "authorization";
token_id: string;
action: string;
payload_hash: string;
status: "pending" | "approved" | "denied" | "expired";
expires_at: number;
signature_url?: string;
approved_by_stakeholder_id?: unknown;
approved_at?: unknown;
denied_reason?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}BankAccount
Typed-ID prefix bka_. Deposit account for an entity. Opened via createBankAccount,
/** Deposit account for an entity. Opened via `createBankAccount`, */
export interface BankAccount {
object: "bank_account";
id: string;
entity_id: string;
status: "pending" | "pending_kyb" | "kyb_pending" | "kyb_held" | "active" | "frozen" | "closing" | "closed";
account_type: "checking" | "savings";
nickname: string;
balance_usd_cents: number;
provider?: "column" | "mercury" | "brex" | "chase" | "ramp" | "other";
account_number?: string;
routing_number?: unknown;
account_number_last_4?: unknown;
kyb_decision?: "approved" | "held_for_review" | "declined" | "not_applicable";
kyb_decided_at?: string;
column_account_id?: string;
sub_agent_session_id?: string;
partner_bank?: "column";
authorized_signer_stakeholder_ids?: Array<string>;
created_at?: string;
activated_at?: unknown;
}BenefitPlan
Typed-ID prefix bp_. Linkage record for an entity's benefit plan or insurance policy.
/** Linkage record for an entity's benefit plan or insurance policy. */
export interface BenefitPlan {
object: "benefit_plan";
id: string;
entity_id: string;
regime: "medical" | "dental" | "vision" | "life_disability" | "retirement_401k" | "retirement_403b" | "hra" | "fsa" | "hsa" | "other";
provider_kind: "benefits_administrator" | "retirement_record_keeper" | "insurance_carrier";
provider_name?: unknown;
external_account_id?: unknown;
linkage_attestation_document_id?: unknown;
adoption_resolution_id?: unknown;
termination_resolution_id?: unknown;
plan_administrator_stakeholder_id?: unknown;
status: "linked" | "terminating" | "terminated";
opened_at?: number;
terminating_at?: unknown;
terminated_at?: unknown;
created: number;
updated: number;
livemode: boolean;
}BillingAlert
Typed-ID prefix alrt_. A billing tripwire. Alerts notify — via billing.alert.fired events and an
/** A billing tripwire. Alerts notify — via `billing.alert.fired` events and an */
export interface BillingAlert {
id: string;
object: "billing_alert";
account_id: string;
metric: "balance_below_cents" | "budget_percent" | "usage_unit_threshold" | "spend_velocity_cents_per_hour";
threshold_value: number;
unit?: "api_call" | "saga_step" | "document_render" | "webhook_attempt" | "audit_read" | "filing_submission" | null;
recurrence: "once" | "per_period";
status: "active" | "disabled";
is_default: boolean;
last_fired_at?: unknown;
webhook_endpoint_id?: unknown;
created: number;
updated: number;
livemode: boolean;
}BrowserAgentRun
Typed-ID prefix bar_. A read-only summary of one fill-no-submit browser-agent run preparing a
/** A read-only summary of one fill-no-submit browser-agent run preparing a */
export interface BrowserAgentRun {
id: string;
object: "browser_agent_run";
entity_id: string;
filing_kind: string;
submitted: false;
state: "pending" | "running" | "deferred" | "prepared" | "blocked";
perception_mode?: "recipe" | "assisted";
region?: string;
computed_fee_usd?: unknown;
observed_fee_usd?: unknown;
proof_bundle_id?: unknown;
content_hash?: unknown;
render_hash?: unknown;
blocker?: Blocker | unknown;
stopped_at?: unknown;
created: number;
}Budget
Typed-ID prefix bud_. A per-period spend fence over an org, portfolio, or token. A block budget
/** A per-period spend fence over an org, portfolio, or token. A `block` budget */
export interface Budget {
id: string;
object: "budget";
scope_kind: "org" | "portfolio" | "token";
scope_id?: unknown;
period: "day" | "month";
cap: MonetaryAmount;
action: "block" | "warn";
created_by_user_id?: unknown;
created_by_token_id?: unknown;
created: number;
updated: number;
livemode: boolean;
}CapTableSnapshot
Typed-ID prefix cts_. Materialized point-in-time cap table, pinned at meaningful moments (priced
/** Materialized point-in-time cap table, pinned at meaningful moments (priced */
export interface CapTableSnapshot {
id: string;
object: "cap_table_snapshot";
entity_id: string;
as_of: number;
reason: "priced_round" | "valuation" | "board_approval" | "fiscal_year_close" | "manual";
cap_table: CapTable;
document_id?: unknown;
valuation_id?: unknown;
actor_id?: unknown;
metadata?: Metadata;
created?: number;
livemode: boolean;
}CorporateTransaction
Typed-ID prefix ctx_. M&A envelope — merger, acquisition, asset sale, stock sale, conversion, or
/** M&A envelope — merger, acquisition, asset sale, stock sale, conversion, or */
export interface CorporateTransaction {
id: string;
object: "corporate_transaction";
kind: "merger" | "acquisition" | "asset_sale" | "stock_sale" | "conversion" | "reorganization" | "acquihire" | "charter_amendment";
parties: Array<{ entity_id: string; role: "acquirer" | "target" | "survivor" | "counterparty" | "seller" | "buyer" | "parent"; signatures_required?: Array<string> }>;
stage: "loi" | "due_diligence" | "definitive" | "regulatory_review" | "closing" | "closed" | "cancelled" | "terminated";
consideration?: { total?: MonetaryAmount; cash?: MonetaryAmount; stock_exchange_ratio?: number; contingent_value_rights?: MonetaryAmount };
consideration_breakdown?: { cash_amount_cents?: unknown; stock_consideration?: Array<{ share_class_id: string; shares: number; valuation_per_share_cents: number }>; earn_out_amount_cents?: unknown; escrow_amount_cents?: unknown; indemnity_holdback_amount_cents?: unknown; assumed_debt_cents?: unknown; transaction_expense_reimbursement_cents?: unknown; cvr_amount_cents?: unknown };
authorizing_resolution_id?: unknown;
effective_date?: unknown;
signing_date?: unknown;
closing_date?: unknown;
treatment?: { options?: { vested?: "cash_out" | "assume" | "cancel" | "exchange_for_acquirer_options"; unvested?: "cash_out" | "assume" | "cancel" | "exchange_for_acquirer_options"; accelerate_basis_points?: number }; warrants?: "exercise_pre_closing" | "cash_out" | "assume" | "cancel"; safes?: "convert_at_cap" | "cash_out" | "terminate"; notes?: "convert_at_cap" | "repay_at_closing" | "assume" };
hsr_required?: boolean;
regulatory_approvals?: Array<{ kind?: "hsr" | "cfius" | "foreign_investment" | "sector_regulator" | "fcc" | "faa" | "banking" | "insurance" | "other"; jurisdiction?: string; status?: "pending" | "filed" | "cleared" | "denied"; filing_id?: unknown }>;
section_280g_analysis?: { ran?: boolean; disqualified_count?: number; excess_parachute?: MonetaryAmount; gross_up?: boolean; shareholder_cleanse_planned?: boolean; analysis_document_id?: unknown };
document_ids?: Array<string>;
escrow_ids?: Array<string>;
earn_out_ids?: Array<string>;
indemnity_claim_ids?: Array<string>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}CourtOrder
Typed-ID prefix co_. A court order recorded against a CourtPetition. Captures the
/** A court order recorded against a `CourtPetition`. Captures the */
export interface CourtOrder {
object: "court_order";
id: string;
court_petition_id: string;
entity_id: string;
order_kind: "dissolution_security_determination" | "distribution_plan_approval" | "extension" | "other";
court_approved_security_amount_cents: number;
approved_distribution_plan: { to_known_creditors_cents: number; to_security_reserve_cents: number; residual_to_stockholders_cents: number; creditor_settlement_method?: unknown; known_creditor_payout_ratio?: unknown; contingent_reserve_held_in?: unknown };
effective_date: string;
order_document_id: string;
chancery_docket_number?: unknown;
appealable_until?: unknown;
judge?: unknown;
recorded_at: number;
created: number;
updated?: number;
livemode: boolean;
metadata?: Metadata;
}CourtPetition
Typed-ID prefix cp_. Verified petition filed with a court of competent jurisdiction in
/** Verified petition filed with a court of competent jurisdiction in */
export interface CourtPetition {
object: "court_petition";
id: string;
entity_id: string;
petition_kind: "dgcl_280_dissolution" | "dgcl_278_post_dissolution";
status: "draft" | "filed" | "docketed" | "under_review" | "granted" | "rejected_by_court" | "withdrawn";
claims_summary: Array<{ creditor_name: string; claim_amount_cents: number; claim_status: "pending" | "disputed" | "acknowledged" | "paid"; basis?: unknown; subordination?: unknown }>;
contingent_reserves_schedule: Array<{ category: "litigation" | "regulatory" | "environmental" | "tax" | "other"; estimated_reserve_cents: number; rationale: string; supporting_rationale_document_id?: unknown }>;
proposed_distribution_plan: { to_known_creditors_cents: number; to_security_reserve_cents: number; residual_to_stockholders_cents: number; ordering?: unknown; summary?: unknown };
affidavit_document_ids: Array<string>;
authorizing_resolution_id?: unknown;
court?: unknown;
chancery_docket_number?: unknown;
court_docket_url?: unknown;
filed_with_matter_at?: unknown;
filed_with_court_at?: unknown;
created: number;
updated: number;
livemode: boolean;
metadata?: Metadata;
}CreditorClaimsWindow
Typed-ID prefix ccw_. Statutory creditor-notice window run during dissolution under DGCL
/** Statutory creditor-notice window run during dissolution under DGCL */
export interface CreditorClaimsWindow {
object: "creditor_claims_window";
id: string;
entity_id: string;
procedure: "default_281" | "long_form_280" | "short_form_282";
statutory_window_days?: number;
publication_date?: unknown;
opened_at?: unknown;
closes_at?: unknown;
closed_at?: unknown;
status: "pending_publication" | "open" | "closed";
known_creditors?: Array<{ recipient_id: string; recipient_name?: string; notice_channel: "certified_mail" | "registered_mail" | "email_with_receipt" | "in_person" | "newspaper_publication_only"; notice_sent_at?: unknown; notice_document_id?: unknown; delivery_confirmed_at?: unknown }>;
publication_records?: Array<{ publication?: string; publication_date?: string; proof_document_id?: string }>;
claims_received?: Array<{ claim_id?: string; claimant_name: string; received_at: string; amount_claimed_usd?: number; basis?: string; status: "open" | "settled" | "denied" | "time_barred"; settled_at?: unknown; settlement_document_id?: unknown }>;
created: number;
updated: number;
livemode: boolean;
}DataRoom
Typed-ID prefix dro_. Permissioned virtual data room scoped to a corporate transaction. Counterparty
/** Permissioned virtual data room scoped to a corporate transaction. Counterparty */
export interface DataRoom {
id: string;
object: "data_room";
transaction_id: string;
name: string;
status: "active" | "expired" | "revoked";
expires_at?: unknown;
watermark_email: boolean;
document_ids?: Array<string>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Director
Typed-ID prefix dir_. Canonical director record. Created by changeDirector (action: elect)
/** Canonical director record. Created by `changeDirector` (action: elect) */
export interface Director {
id: string;
object: "director";
entity_id: string;
stakeholder_id: string;
board_seat?: number;
status: "active" | "removed";
effective_date: string;
elected_via_resolution_id?: string;
removed_via_resolution_id?: string;
livemode?: boolean;
}Document
Typed-ID prefix doc_. Legal document. Dual artifact — structured JSON (GET /documents/{id}) and rendered
/** Legal document. Dual artifact — structured JSON (`GET /documents/{id}`) and rendered */
export interface Document {
id: string;
object: "document";
entity_id: string;
type: "certificate_of_incorporation" | "certificate_of_amendment" | "certificate_of_dissolution" | "restated_certificate_of_incorporation" | "bylaws" | "operating_agreement" | "secretary_certificate" | "incorporator_certificate" | "action_of_incorporator" | "board_consent" | "written_consent" | "initial_board_resolution" | "stockholders_agreement" | "stock_certificate" | "founder_stock_purchase_agreement" | "stock_power" | "stock_receipt" | "equity_plan" | "grant_notice" | "83b_election" | "indemnification_agreement" | "safe" | "convertible_note" | "pro_rata_side_letter" | "side_letter" | "stock_purchase_agreement" | "investors_rights_agreement" | "voting_agreement" | "rofr_co_sale_agreement" | "management_rights_letter" | "legal_opinion" | "director_officer_questionnaire" | "five_percent_holder_questionnaire" | "accredited_investor_questionnaire" | "loi" | "merger_agreement" | "asset_purchase_agreement" | "annual_report" | "boi_report" | "form_966" | "cap_table_snapshot" | "registered_agent_appointment" | "mail_scan" | "identification_image" | "csa" | "mnda" | "psa" | "pilot_agreement" | "design_partner_agreement" | "software_license" | "marketplace_terms" | "reseller_agreement" | "end_user_agreement" | "online_cloud_terms" | "independent_contractor_agreement" | "advisor_agreement" | "employment_agreement" | "offer_letter" | "ciiaa" | "officer_change_consent" | "director_change_consent" | "trademark_application" | "plan_of_dissolution" | "notice_of_dissolution" | "creditor_publication_record" | "safe_release" | "convertible_release" | "ein_deactivation_letter" | "ein_deactivation_acknowledgement" | "records_retention_plan" | "liquidating_distribution_statement" | "final_form_966" | "certificate_of_withdrawal" | "form_1099_c" | "settlement_agreement" | "baa_termination_notice" | "phi_return_destruction_attestation" | "dpa_termination_notice" | "cobra_qualifying_event_notice" | "cobra_general_notice" | "cobra_election_form" | "cobra_termination_notice" | "insurance_policy_termination_notice" | "benefits_carrier_termination_acknowledgement" | "payroll_provider_attestation" | "benefit_plan_attestation" | "cofounder_agreement" | "cofounder_ip_assignment" | "banking_authorization_certificate" | "baa" | "subprocessor_baa" | "mfn_amendment" | "separation_agreement" | "eighty_three_b_amendment" | "cobra_dissolution_honored_coverage_attestation" | "chancery_court_order" | "share_certificate_cancellation_declaration" | "280g_cleansing_vote_disclosure_statement" | "280g_excise_tax_assessment" | "separation_agreement_with_mutual_release" | "spousal_consent" | "indemnity_carve_out_release" | "pro_rata_release" | "rd_credit_study" | "transfer_agent_engagement_letter" | "chancery_court_petition" | "custom";
provenance?: "matter_generated" | "counterpart_received" | "user_uploaded";
status: "draft" | "final" | "signed" | "filed" | "efiled" | "void";
execution_status: "draft" | "sent" | "partially_signed" | "executed" | "void" | "superseded" | "terminated";
lifecycle_class?: "agreement" | "tax_filing" | "acknowledgement" | "checklist" | "counterpart_received";
upstream_provenance?: unknown;
terminated_at?: unknown;
terminated_reason?: null | "dissolution" | "mutual_termination" | "breach_cured" | "natural_expiration" | "other";
clause_toggles?: Array<{ clause_id: string; current_value: unknown; default_value: unknown; override_basis?: null | "founder_intent" | "counsel_advice" | "board_resolution" | "prior_practice"; set_at?: unknown; set_by_stakeholder_id?: unknown }>;
clause_toggle_changes?: Array<{ clause_id: string; previous_value: unknown; new_value: unknown; override_basis?: null | "founder_intent" | "counsel_advice" | "board_resolution" | "prior_practice"; changed_at: number; changed_by_stakeholder_id: string; note?: unknown }>;
internal_notes?: unknown;
structured_clauses?: Array<{ clause_id: string; value_type: "integer" | "basis_points" | "boolean" | "enum_value" | "monetary_amount"; value: unknown; source_section?: unknown; extracted_at?: unknown }>;
efile_metadata?: unknown;
attaches_to?: unknown;
attachment_kind?: null | "sla" | "dpa" | "baa" | "ai_addendum" | "side_letter" | "pro_rata_side_letter" | "amendment" | "exhibit" | "schedule" | "spousal_consent" | "pro_rata_release" | "indemnity_carve_out_release" | "closing_condition";
related_documents?: Array<{ document_id: string; relation_kind: "co_executed_with" | "paired_witness_of" | "supersedes" | "superseded_by" | "amends" | "amended_by" | "companion_to" | "cross_signed_with" | "referenced_by" | "references"; note?: unknown; established_at?: unknown }>;
cover_page_fields?: unknown;
equity_promise?: unknown;
standard_terms_template_id?: unknown;
template_id?: unknown;
template_version?: unknown;
current_version_id?: unknown;
entity_snapshot?: Record<string, unknown>;
payload?: Record<string, unknown>;
pdf_url?: unknown;
sha256: string;
proof?: unknown;
version: number;
parent_document_id?: unknown;
signatures?: Array<{ stakeholder_id: string; signed_at: number; signature_method: "esign" | "wet_signature" | "agent_authorized"; legal_basis: "wet_signature" | "esra_consent" | "ueta_electronic_agent"; consent_record?: ConsentRecord; agent_authority?: AgentAuthority; intent_text?: unknown }>;
envelope_id?: unknown;
sensitivity?: "standard" | "restricted";
disclaimer?: Disclaimer;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}DocumentAccessGrant
Typed-ID prefix dag_. Permissioned access to a document for a specific grantee (typically scoped to
/** Permissioned access to a document for a specific grantee (typically scoped to */
export interface DocumentAccessGrant {
id: string;
object: "document_access_grant";
document_id: string;
data_room_id?: unknown;
grantee_email: string;
grantee_stakeholder_id?: unknown;
permissions: Array<"view" | "download" | "comment">;
status: "active" | "expired" | "revoked";
expires_at?: unknown;
last_accessed_at?: unknown;
access_count?: number;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}DocumentVersion
Typed-ID prefix docv_. Immutable point-in-time snapshot of a Document. Each regenerate, sign,
/** Immutable point-in-time snapshot of a `Document`. Each regenerate, sign, */
export interface DocumentVersion {
id: string;
object: "document_version";
document_id: string;
version: number;
status: "draft" | "final" | "signed" | "filed" | "void";
sha256: string;
payload?: Record<string, unknown>;
pdf_url?: unknown;
proof?: unknown;
actor_id?: unknown;
change_kind?: "generated" | "regenerated" | "signed" | "voided" | "amended";
previous_version_id?: unknown;
created: number;
livemode?: boolean;
}EarnOut
Typed-ID prefix eo_. Contingent post-closing consideration tied to performance metrics. Common in
/** Contingent post-closing consideration tied to performance metrics. Common in */
export interface EarnOut {
id: string;
object: "earn_out";
corporate_transaction_id: string;
metric: "revenue" | "ebitda" | "gross_margin" | "customer_count" | "milestone_completion" | "other";
target: MonetaryAmount;
max_payout?: MonetaryAmount;
periods?: Array<{ period_start: string; period_end: string; target_for_period?: MonetaryAmount; measurement_id?: unknown }>;
true_up_mechanic?: "period_only" | "cumulative" | "catch_up";
formula?: unknown;
current_status?: "active" | "satisfied" | "extinguished";
payout_schedule?: Array<{ scheduled_date: string; amount_cents: number; recipient_stakeholder_id?: unknown; status: "scheduled" | "paid" | "adjusted" | "cancelled"; paid_at?: unknown }>;
status: "active" | "completed" | "expired" | "disputed";
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Entity
Typed-ID prefix ent_. A legal entity — the central object of the Matter API. Entities flow through the
/** A legal entity — the central object of the Matter API. Entities flow through the */
export interface Entity {
id: string;
object: "entity";
status: "draft" | "submitted" | "registered" | "active" | "suspended" | "in_transaction" | "dissolving" | "winding_down" | "tax_cleared" | "dissolved" | "acquired" | "merged" | "sold" | "rejected" | "cancelled";
type: "c_corp" | "s_corp" | "llc" | "benefit_corp" | "nonprofit" | "lp" | "llp";
jurisdiction: Jurisdiction;
legal_name: string;
aliases?: Array<string>;
formed_at?: unknown;
dissolved_at?: unknown;
acquired_at?: unknown;
merged_at?: unknown;
sold_at?: unknown;
workspace_id?: unknown;
corporate_transaction_id?: unknown;
principal_address?: Address;
mailing_address?: Address;
registered_agent_id?: string;
incorporator_stakeholder_id?: string;
tax_profile_id?: string;
stakeholder_ids?: Array<string>;
cap_table_id?: string;
equity_plan_ids?: Array<string>;
qualifications?: Array<Qualification>;
compliance?: { health?: "healthy" | "attention" | "lapsed"; next_deadline?: unknown; open_obligations_count?: number };
intent_id?: unknown;
incorporator_receipt_id?: unknown;
portfolio_id?: unknown;
governing_documents?: { certificate_of_incorporation_id?: unknown; restated_certificate_of_incorporation_id?: unknown; bylaws_id?: unknown; action_of_incorporator_id?: unknown; secretary_certificate_id?: unknown; initial_board_consent_id?: unknown };
formation_packet_status?: "not_started" | "pending" | "incorporator_action_complete" | "bylaws_adopted" | "initial_resolutions_executed" | "founder_stock_issued" | "83b_window_open" | "indemnification_signed" | "ein_obtained" | "complete";
external_status?: "pending" | "registered" | "failed" | "prepared" | "blocked";
active_browser_agent_run_id?: unknown;
browser_agent_run?: BrowserAgentRun | unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}EntityTemplateOverride
Typed-ID prefix eto_. Entity-scoped overlay. Same shape as OrgTemplateCustomization,
/** Entity-scoped overlay. Same shape as `OrgTemplateCustomization`, */
export interface EntityTemplateOverride {
object: "entity_template_override";
id: string;
entity_id: string;
org_id: string;
template_id: string;
mode: "live" | "sandbox" | "test";
compatible_revisions_min: string;
compatible_revisions_max: string;
clause_overlays: Array<Record<string, unknown>>;
field_default_overlays: Array<Record<string, unknown>>;
signer_role_overrides: Array<Record<string, unknown>>;
attachments: Array<Record<string, unknown>>;
authored_against_revision_id?: unknown;
deleted_at?: unknown;
created?: string;
updated?: string;
}EquityPlan
Typed-ID prefix plan_. Authorized option pool or stock plan. Grants are drawn from a plan.
/** Authorized option pool or stock plan. Grants are drawn from a plan. */
export interface EquityPlan {
id: string;
object: "equity_plan";
entity_id: string;
name: string;
type: "stock_plan" | "option_pool";
authorized_shares: number;
reserved_shares?: number;
granted_shares: number;
available_shares?: number;
effective_date: string;
board_resolution_id?: string;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Escrow
Typed-ID prefix esc_. Holdback of consideration at closing for indemnity, working-capital, or special-
/** Holdback of consideration at closing for indemnity, working-capital, or special- */
export interface Escrow {
id: string;
object: "escrow";
corporate_transaction_id: string;
amount: MonetaryAmount;
percent_of_consideration_basis_points?: number;
period_months: number;
agent?: string;
purpose?: Array<"indemnity" | "working_capital" | "special_indemnity" | "regulatory">;
status: "funded" | "partial_release" | "released" | "claimed";
release_schedule?: Array<{ scheduled_date: string; amount: MonetaryAmount; status: "pending" | "released" | "withheld"; released_at?: unknown }>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Event
Typed-ID prefix evt_. Webhook event. Every state change emits exactly one. Strict per-subject ordering
/** Webhook event. Every state change emits exactly one. Strict per-subject ordering */
export interface Event {
id: string;
object: "event";
type: string;
api_version: string;
created: number;
data: { object: { id: string; object_type: string } };
sequence: number;
livemode: boolean;
pending_webhooks?: number;
request?: { id?: string; idempotency_key?: unknown };
authorized_by?: AuthorizedBy;
}EvidenceBundle
Typed-ID prefix evb_. Litigation-grade self-contained ZIP artifact produced by
/** Litigation-grade self-contained ZIP artifact produced by */
export interface EvidenceBundle {
object: "evidence_bundle";
id: string;
document_id: string;
archive_uri: string;
content_sha256: string;
manifest: Record<string, unknown>;
chain_signature: string;
created: string;
}File
Typed-ID prefix file_. A byte-level artifact — stakeholder KYC document, cap-table CSV import,
/** A byte-level artifact — stakeholder KYC document, cap-table CSV import, */
export interface File {
id: string;
object: "file";
purpose: "kyc_document" | "cap_table_import" | "board_attachment" | "dd_document" | "resolution_attachment" | "logo";
size: number;
type: string;
filename?: unknown;
sha256: string;
linked_resources?: Array<{ type?: string; id?: string; field?: string }>;
expires_at?: unknown;
metadata?: Metadata;
created: number;
livemode: boolean;
}FileLink
Typed-ID prefix link_. A time-limited signed URL to a File's bytes. Reissue after expiry.
/** A time-limited signed URL to a `File`'s bytes. Reissue after expiry. */
export interface FileLink {
id: string;
object: "file_link";
file_id: string;
url: string;
expires_at: number;
metadata?: Metadata;
created: number;
livemode: boolean;
}Filing
Typed-ID prefix flg_. A state or federal filing. Polymorphic — payload is discriminated by type.
/** A state or federal filing. Polymorphic — `payload` is discriminated by `type`. */
export interface Filing {
id: string;
object: "filing";
entity_id: string;
type: "certificate_of_amendment" | "annual_report" | "franchise_tax" | "final_franchise_tax" | "boi_report" | "boi_update" | "boi_closure" | "form_966" | "form_1120" | "form_1120w" | "form_941" | "form_941_final" | "form_6765" | "form_d" | "blue_sky_notice" | "stock_split" | "custom" | "eighty_three_b_election" | "certificate_of_incorporation" | "certificate_of_dissolution" | "ein_application" | "foreign_qualification" | "registered_agent_change" | "conversion" | "certificate_of_merger" | "articles_of_merger" | "plan_of_merger" | "bill_of_sale" | "assignment_and_assumption_agreement" | "stock_purchase_agreement" | "form_8k_m_and_a" | "ca_statement_of_information_final" | "ca_form_100_final" | "ca_ftb_tax_clearance_request" | "ca_ftb_tax_clearance_certificate" | "ca_certificate_of_surrender" | "ny_franchise_tax_final" | "ny_dot_consent_to_dissolution" | "ny_certificate_of_surrender_of_authority" | "tx_comptroller_tax_clearance_letter" | "tx_certificate_of_withdrawal" | "ma_form_355_final" | "ma_dor_corporate_tax_clearance" | "ma_certificate_of_surrender_foreign_corp" | "ca_edd_clearance_request" | "ny_dol_clearance_request" | "wa_esd_clearance_request" | "ma_dor_employer_clearance_request" | "il_form_1120_final" | "il_dor_tax_clearance_request" | "il_dor_tax_clearance_certificate" | "il_application_for_withdrawal_foreign_corp" | "il_des_employer_clearance_request" | "fl_form_f1120_final" | "fl_dor_tax_clearance_request" | "fl_dor_tax_clearance_certificate" | "fl_application_for_withdrawal_foreign_corp" | "wa_combined_excise_tax_return_final" | "wa_dor_tax_clearance_request" | "wa_dor_tax_clearance_certificate" | "wa_certificate_of_withdrawal_foreign_corp" | "co_form_dr0112_final" | "co_dor_tax_clearance_request" | "co_dor_tax_clearance_certificate" | "co_statement_of_withdrawal_foreign_corp" | "ga_form_600_final" | "ga_dor_tax_clearance_request" | "ga_dor_tax_clearance_certificate" | "ga_application_for_certificate_of_withdrawal" | "nj_form_cbt100_final" | "nj_dot_tax_clearance_request" | "nj_dot_tax_clearance_certificate" | "nj_certificate_of_withdrawal_foreign_corp" | "pa_form_rct101_final" | "pa_dor_tax_clearance_request" | "pa_dor_tax_clearance_certificate" | "pa_application_for_termination_of_authority" | "va_form_500_final" | "va_dot_tax_clearance_request" | "va_dot_tax_clearance_certificate" | "va_application_for_certificate_of_withdrawal" | "irs_ein_deactivation_request" | "irs_form_1099_c" | "irs_form_5310" | "irs_form_5500_final" | "ca_state_withholding_final" | "ca_state_unemployment_final" | "ny_state_withholding_final" | "ny_state_unemployment_final" | "wa_state_withholding_final" | "wa_state_unemployment_final" | "ma_state_withholding_final" | "ma_state_unemployment_final" | "irs_form_1094c_final" | "irs_form_1095c_final" | "il_des_employer_account_closure" | "il_dor_withholding_account_closure" | "ga_dol_employer_account_closure" | "ga_dor_withholding_account_closure" | "fl_dor_reemployment_account_closure" | "co_dor_employer_account_closure" | "ca_de_9" | "ca_de_9c" | "ny_nys_45" | "il_ui_3_40" | "tx_twc_c3" | "tx_public_information_report" | "tx_franchise_tax_report" | "revival_filing" | "form_8x" | "irs_audit_response_4470" | "boi_closure_foreign_reporting" | "chancery_court_petition_filing" | "chancery_court_order_recording";
jurisdiction: Jurisdiction;
status: "preparing" | "submitted" | "accepted" | "rejected" | "amended" | "cancelled";
payload?: FilingPayloadCertificateOfAmendment | FilingPayloadAnnualReport | FilingPayloadFranchiseTax | FilingPayloadBoiInitial | FilingPayloadBoiUpdate | FilingPayloadForm966 | FilingPayloadFormD | FilingPayloadCustom;
submitted_at?: unknown;
accepted_at?: unknown;
rejected_reason?: unknown;
state_confirmation_number?: unknown;
document_ids?: Array<string>;
authorizing_resolution_id?: unknown;
authorizing_corporate_transaction_id?: unknown;
prerequisite_filings?: Array<string>;
depends_on?: Array<string>;
final_return?: boolean;
post_dissolution_filing?: boolean;
fees?: { platform?: MonetaryAmount; passthrough?: MonetaryAmount };
cancellation_window_ends_at?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}FormationSession
Typed-ID prefix fss_. Tracks the multi-step formation flow for a single entity
/** Tracks the multi-step formation flow for a single entity */
export interface FormationSession {
id: string;
object: "formation_session";
entity_id: string;
intent_id?: unknown;
mode: "live" | "sandbox" | "test";
status: "started" | "entity_created" | "docs_signed" | "filing_submitted" | "ein_received" | "bank_opened" | "active" | "expired";
current_step: string;
progress?: unknown;
started_at: string;
completed_at?: unknown;
version: number;
created_at: string;
updated_at: string;
}Grant
Typed-ID prefix grt_. Option, RSU, or restricted-stock grant. The kind enum covers both
/** Option, RSU, or restricted-stock grant. The `kind` enum covers both */
export interface Grant {
id: string;
object: "grant";
entity_id: string;
stakeholder_id: string;
equity_plan_id?: unknown;
kind: "iso" | "nso" | "rsu" | "rsa" | "founder_restricted_stock";
quantity: number;
strike_price?: MonetaryAmount;
valuation_id?: unknown;
vesting_schedule?: { cliff_months?: number; total_months?: number; granularity?: "monthly" | "quarterly" | "annually"; reverse_vesting?: boolean; commencement_date?: unknown };
acceleration_condition?: "none" | "single_trigger" | "double_trigger" | "discretionary_on_departure" | null;
acceleration_events?: Array<{ trigger: "single_trigger_change_of_control" | "double_trigger_change_of_control_and_termination" | "ipo" | "termination_without_cause" | "termination_for_good_reason" | "death_disability" | "board_discretion"; percent: number; description?: string }>;
clawback?: unknown;
election_83b?: unknown;
founder_restricted_stock_terms?: unknown;
amended_from_grant_id?: unknown;
amendment_reason?: null | "strike_price_repricing" | "expiration_extension" | "vesting_modification" | "quantity_increase" | "quantity_decrease" | "acceleration_grant" | "cancellation" | "other";
grant_date: string;
expiration_date?: unknown;
exercised_quantity?: number;
document_id?: unknown;
qsbs_eligibility_date?: unknown;
pre_409a_grant_pause_until?: unknown;
status?: "active" | "handshake_pending" | "vesting" | "vested" | "exercised" | "cancelled";
activated_at?: unknown;
documents?: { grant_agreement_id?: string; board_consent_id?: string };
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}IncorporatorReceipt
Typed-ID prefix ir_. Immutable cryptographic proof issued at the end of a successful incorporator
/** Immutable cryptographic proof issued at the end of a successful incorporator */
export interface IncorporatorReceipt {
object: "incorporator_receipt";
id: string;
entity_id: string;
genesis_ceremony_id: string;
audit_chain_root_hash: string;
rekor_inclusion_proof?: unknown;
witness_signatures?: unknown;
issued_at: string;
created_at: string;
updated_at: string;
}IndemnificationAgreement
Typed-ID prefix ind_. Director-and-officer indemnification covenant between an entity and an
/** Director-and-officer indemnification covenant between an entity and an */
export interface IndemnificationAgreement {
id: string;
object: "indemnification_agreement";
entity_id: string;
indemnitee_stakeholder_id: string;
role: "director" | "officer" | "both";
authorizing_resolution_id?: unknown;
document_id?: unknown;
envelope_id?: unknown;
effective_date?: unknown;
termination_date?: unknown;
coverage?: { advancement_of_expenses?: boolean; includes_attorneys_fees?: boolean; scope?: "mandatory" | "permissive" | "mandatory_with_carveouts"; change_of_control_acceleration?: boolean; d_and_o_insurance_required?: boolean; d_and_o_minimum_coverage_cents?: unknown };
status: "draft" | "sent" | "signed" | "terminated" | "void";
signed_at?: unknown;
terminated_at?: unknown;
termination_reason?: null | "departure" | "replacement" | "mutual" | "breach" | "statutory_revocation";
carve_outs?: Array<{ category: "scope_carveout" | "cap_carveout" | "basket_carveout" | "survival_carveout" | "disclosed_schedule_exception"; cap_amount_cents?: unknown; survival_period_months?: unknown; basket_amount_cents?: unknown; disclosed_schedule_id?: unknown; status: "active" | "released"; release_document_id?: unknown; release_resolution_id?: unknown; released_at?: unknown }>;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}IndemnityClaim
Typed-ID prefix idc_. A claim by acquirer (or rarely seller) under the definitive agreement's
/** A claim by acquirer (or rarely seller) under the definitive agreement's */
export interface IndemnityClaim {
id: string;
object: "indemnity_claim";
corporate_transaction_id: string;
claimant: string;
amount: MonetaryAmount;
basis: string;
fundamental_carveout?: boolean;
response_deadline?: unknown;
status: "filed" | "accepted" | "disputed" | "paid" | "denied" | "withdrawn";
kind?: null | "alleged_rep_breach" | "tax_liability" | "environmental" | "other";
resolution_path?: null | "settled_via_escrow_draw" | "settled_via_carve_out_release" | "settled_via_payment" | "denied" | "withdrawn";
release_document_id?: unknown;
escrow_id?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Intent
Typed-ID prefix int_. Customer-facing label: Incorporation plan (or, more generally, a
/** Customer-facing label: **Incorporation plan** (or, more generally, a */
export interface Intent {
id: string;
object: "intent";
goal: "start_company" | "hire_worker" | "bring_on_advisor" | "take_investment" | "raise_capital" | "expand_equity_pool" | "open_bank_account" | "send_customer_contract" | "make_decision" | "refresh_valuation" | "stay_compliant" | "expand_to_state" | "prepare_for_fundraise" | "sell_company" | "wind_down" | "elect_s_corp" | "register_dba" | "obtain_ein" | "form_startup_ready_corporation" | "form_llc" | "form_benefit_corp" | "form_nonprofit" | "dissolve_entity" | "foreign_qualify" | "convert_entity" | "issue_priced_round" | "issue_safe_round" | "refresh_option_pool" | "execute_merger" | "execute_acquisition" | "execute_asset_sale" | "execute_stock_sale" | "execute_reorganization";
parameters: StartCompanyParameters | HireWorkerParameters | TakeInvestmentParameters | MakeDecisionParameters | Record<string, unknown>;
status: "draft" | "resolved" | "executing" | "completed" | "cancelled" | "failed";
execution_plan?: ExecutionPlan;
entity_id?: unknown;
cost_estimate?: MonetaryAmount;
completed_at?: unknown;
resolved_recommendations?: Array<Recommendation>;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}Invoice
Typed-ID prefix inv_. An invoice issued to the account — entity-license subscription invoices and
/** An invoice issued to the account — entity-license subscription invoices and */
export interface Invoice {
id: string;
object: "invoice";
account_id: string;
number?: unknown;
status: "draft" | "open" | "paid" | "void" | "uncollectible";
total: MonetaryAmount;
lines?: Array<{ description?: string; quantity?: number; amount?: MonetaryAmount }>;
hosted_invoice_url?: unknown;
pdf_url?: unknown;
period_start?: unknown;
period_end?: unknown;
paid_at?: unknown;
created: number;
updated: number;
livemode: boolean;
}JurisdictionVariant
Typed-ID prefix jvr_. Per-jurisdiction overrides applied between the platform body
/** Per-jurisdiction overrides applied between the platform body */
export interface JurisdictionVariant {
object: "jurisdiction_variant";
id: string;
template_revision_id: string;
jurisdiction: string;
clause_overrides?: Record<string, unknown>;
signer_overrides?: Record<string, unknown>;
legal_basis_overrides?: Record<string, unknown>;
}LedgerEntry
Typed-ID prefix lgr_. One append-only money movement on the account's prepaid ledger. Entries are
/** One append-only money movement on the account's prepaid ledger. Entries are */
export interface LedgerEntry {
id: string;
object: "ledger_entry";
account_id: string;
kind: "top_up" | "auto_recharge" | "usage_debit" | "license_debit" | "fee_passthrough_debit" | "adjustment_credit" | "adjustment_debit" | "refund_reversal" | "promo_credit" | "expiry" | "sandbox_seed";
amount: MonetaryAmount;
balance_after: MonetaryAmount;
source_type: "payment" | "refund" | "usage_window" | "request" | "saga" | "manual" | "reconciliation" | "sandbox";
source_id: string;
request_id?: unknown;
created: number;
livemode: boolean;
}LegalOpinion
Typed-ID prefix lgo_. Closing-condition legal opinion delivered by counsel. Standard on priced
/** Closing-condition legal opinion delivered by counsel. Standard on priced */
export interface LegalOpinion {
id: string;
object: "legal_opinion";
entity_id: string;
parent: { kind: "round" | "corporate_transaction"; id: string };
issuing_firm: string;
issuing_attorney?: unknown;
opinions_covered?: Array<"corporate_existence" | "due_authorisation" | "valid_issuance" | "non_assessability" | "exemption_from_registration" | "no_conflict_with_charter" | "no_conflict_with_material_contracts" | "enforceability_of_transaction_documents" | "regulatory_compliance" | "title_to_assets" | "tax" | "custom">;
document_id?: unknown;
delivered_at?: unknown;
status: "requested" | "drafting" | "delivered" | "withdrawn";
qualifications?: Array<string>;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}MailItem
Typed-ID prefix mail_. One piece of inbound correspondence received by the registered agent on behalf of an
/** One piece of inbound correspondence received by the registered agent on behalf of an */
export interface MailItem {
id: string;
object: "mail_item";
entity_id: string;
source: "registered_agent_scan";
category: "service_of_process" | "tax_notice" | "state_notice" | "court_filing" | "bank" | "vendor" | "junk" | "other";
status: "received" | "acknowledged" | "responded" | "escalated" | "archived";
sender?: unknown;
return_address?: Address | unknown;
subject?: unknown;
ocr_text?: unknown;
extracted?: unknown;
response_deadline?: unknown;
received_at: number;
scanned_at?: unknown;
scan_document_id?: unknown;
response_document_id?: unknown;
related_filing_id?: unknown;
escalation_authorization_id?: unknown;
forwarding?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}Officer
Typed-ID prefix off_. Canonical officer record. Created by changeOfficer (action: appoint)
/** Canonical officer record. Created by `changeOfficer` (action: appoint) */
export interface Officer {
id: string;
object: "officer";
entity_id: string;
stakeholder_id: string;
title: "ceo" | "president" | "coo" | "cto" | "cfo" | "secretary" | "treasurer";
status: "active" | "removed";
effective_date: string;
appointed_via_resolution_id?: string;
removed_via_resolution_id?: string;
removed_at?: string;
livemode?: boolean;
}OrgTemplateCustomization
Typed-ID prefix otc_. Org-scoped overlay — applies to every entity in the org. Per
/** Org-scoped overlay — applies to every entity in the org. Per */
export interface OrgTemplateCustomization {
object: "org_template_customization";
id: string;
org_id: string;
template_id: string;
mode: "live" | "sandbox" | "test";
compatible_revisions_min: string;
compatible_revisions_max: string;
clause_overlays: Array<Record<string, unknown>>;
field_default_overlays: Array<Record<string, unknown>>;
signer_role_overrides: Array<Record<string, unknown>>;
attachments: Array<Record<string, unknown>>;
authored_against_revision_id?: unknown;
deleted_at?: unknown;
created?: string;
updated?: string;
created_by_token_id?: unknown;
updated_by_token_id?: unknown;
}ParachuteAnalysis
Typed-ID prefix pa_. Structured §280G analysis attached to a CorporateTransaction. Identifies
/** Structured §280G analysis attached to a `CorporateTransaction`. Identifies */
export interface ParachuteAnalysis {
id: string;
object: "parachute_analysis";
corporate_transaction_id: string;
analysis_kind: "pre_close" | "post_close_recharacterization" | "revised";
status: "draft" | "computed" | "disclosed" | "voted_passed" | "voted_failed" | "extinguished";
disqualified_individuals: Array<{ stakeholder_id: string; status_kind: "officer" | "one_percent_holder" | "top_percent_paid_employee" | "family_or_business_related" | "other_high_comp"; status_basis?: unknown; tenure_years?: unknown }>;
parachute_payments_breakdown: Array<{ stakeholder_id: string; base_amount_cents: number; acceleration_value_cents?: number; change_in_control_bonus_cents?: number; severance_cents?: number; other_parachutes_cents?: number; total_parachutes_cents: number; three_x_threshold_cents: number; threshold_breach: boolean; excess_parachute_payment_cents?: unknown }>;
disclosure_document_id?: unknown;
cleansing_vote_resolution_id?: unknown;
tax_counsel_firm?: unknown;
override_assumptions?: unknown;
computed_at?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}Portfolio
Typed-ID prefix pf_. Venture-studio grouping. First-class resource — safer than implicit header-based
/** Venture-studio grouping. First-class resource — safer than implicit header-based */
export interface Portfolio {
id: string;
object: "portfolio";
mode: "live" | "sandbox" | "test";
name: string;
shared_registered_agent_id: unknown;
shared_compliance_calendar: boolean;
entity_ids: Array<string>;
version: number;
metadata: Metadata;
created_at: string;
updated_at: string;
}Qualification
Typed-ID prefix qal_. A foreign qualification — registration of an entity in a non-home jurisdiction.
/** A foreign qualification — registration of an entity in a non-home jurisdiction. */
export interface Qualification {
id: string;
object: "qualification";
entity_id: string;
jurisdiction: Jurisdiction;
status: "qualifying" | "qualified" | "withdrawing" | "withdrawn";
qualified_at?: unknown;
registered_agent_id?: unknown;
compliance_track?: { annual_report_due_on?: unknown; franchise_tax_due_on?: unknown };
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Questionnaire
Typed-ID prefix qst_. Structured questionnaire collected from a stakeholder. Used as a closing
/** Structured questionnaire collected from a stakeholder. Used as a closing */
export interface Questionnaire {
id: string;
object: "questionnaire";
entity_id: string;
kind: "director_officer" | "five_percent_holder" | "accredited_investor" | "kyc";
subject_stakeholder_id: string;
related_round_id?: unknown;
related_corporate_transaction_id?: unknown;
responses?: QuestionnaireResponseDirectorOfficer | QuestionnaireResponseFivePercentHolder | QuestionnaireResponseAccreditedInvestor | QuestionnaireResponseKyc;
document_id?: unknown;
envelope_id?: unknown;
signed_at?: unknown;
status: "draft" | "sent" | "completed" | "signed" | "void";
verification?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}RegisteredAgent
Typed-ID prefix ra_. Registered agent of record in a jurisdiction. Required by every state. Swapping a
/** Registered agent of record in a jurisdiction. Required by every state. Swapping a */
export interface RegisteredAgent {
id: string;
object: "registered_agent";
entity_id: string;
jurisdiction: Jurisdiction;
provider: "matter" | "external";
external_provider_name?: unknown;
address: Address;
effective_date: string;
terminated_at?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}ReportRun
Typed-ID prefix run_. An async report run. Starts in pending, advances through running to
/** An async report run. Starts in `pending`, advances through `running` to */
export interface ReportRun {
id: string;
object: "report_run";
report_type: "portfolio_compliance_coverage" | "cap_table_snapshot" | "audit_log_export" | "filing_history";
status: "pending" | "running" | "succeeded" | "failed";
parameters: Record<string, unknown>;
format?: "csv" | "json" | "jsonl" | "xlsx";
result?: unknown;
error?: unknown;
started_at?: unknown;
finished_at?: unknown;
metadata?: Metadata;
created: number;
updated?: number;
livemode: boolean;
}Request
Typed-ID prefix req_. Record of a single API request. Retained 7 days by default (extensible per plan).
/** Record of a single API request. Retained 7 days by default (extensible per plan). */
export interface Request {
id: string;
object: "request";
method: "GET" | "POST" | "DELETE" | "PATCH" | "PUT";
path: string;
status: number;
idempotency_key?: unknown;
actor?: { type?: "user" | "agent" | "platform"; id?: string };
authorized_by?: AuthorizedBy;
request_body?: unknown;
response_body?: unknown;
occurred_at: number;
livemode: boolean;
}Resolution
Typed-ID prefix res_. Board meeting or written consent authorizing entity actions.
/** Board meeting or written consent authorizing entity actions. */
export interface Resolution {
id: string;
object: "resolution";
entity_id: string;
kind: "board_meeting" | "written_consent" | "bylaws_adoption" | "officer_election" | "bank_account_authorisation" | "share_issuance_authorisation" | "option_plan_adoption" | "indemnification_form_approval" | "registered_agent_appointment" | "safe_issuance" | "priced_round_authorisation" | "merger_approval" | "stockholder_consent_merger" | "acquisition_approval" | "asset_sale_approval" | "stock_sale_approval" | "transaction_authorisation" | "plan_of_dissolution" | "dissolution_authorisation" | "dissenters_rights_waiver" | "benefit_plan_adoption" | "benefit_plan_termination" | "benefit_plan_administrator_designation" | "state_employer_account_closure" | "amend_founder_grants" | "authorize_share_repurchase" | "authorize_distribution" | "founder_stock_repurchase_authorization" | "officer_change" | "officer_reslate_after_departure" | "separation_agreement_authorization" | "cleansing_vote" | "280g_recharacterization_acknowledgement" | "court_supervised_dissolution_authorisation" | "acquihire_authorisation" | "share_repurchase_authorisation";
subject: string;
resolved_at?: unknown;
variant?: "sole_director" | "joint_director" | "board_consent" | "stockholder_consent" | "written_consent_in_lieu" | null;
signatories?: Array<{ stakeholder_id?: string; signed_at?: unknown; role?: string; signing_capacity?: "director" | "officer" | "stockholder" | "convertible_holder" | "observer" | "indemnitee" | "non_disqualified_stockholder" | "spouse_of_stockholder" | null }>;
officer_changes?: Array<{ stakeholder_id: string; change_kind: "appoint" | "remove" | "retitle"; title: string; effective_date?: unknown; previous_title?: unknown }>;
document_id?: unknown;
authorizes_filings?: Array<string>;
authorizes_agreements?: Array<string>;
authorizes_grants?: Array<string>;
authorizes_share_reservations?: Array<string>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Round
Typed-ID prefix rnd_. Priced-round envelope. Owns the multi-week negotiation between term-sheet entry
/** Priced-round envelope. Owns the multi-week negotiation between term-sheet entry */
export interface Round {
id: string;
object: "round";
entity_id: string;
name: string;
kind: "seed_priced" | "series_a" | "series_b" | "series_c" | "series_d" | "series_e_plus" | "bridge_priced" | "recap";
stage: "term_sheet" | "drafting" | "signed" | "closed" | "cancelled";
pre_money?: MonetaryAmount;
investment?: MonetaryAmount;
post_money?: MonetaryAmount;
price_per_share?: MonetaryAmount;
option_pool_refresh_basis_points?: number;
pre_money_pool_shuffle?: boolean;
share_class_id?: unknown;
share_class?: Record<string, unknown>;
board_reconstitution?: { investor_seats?: number; common_seats?: number; independent_seats?: number };
investors?: Array<{ stakeholder_id?: string; commitment?: MonetaryAmount; shares_issued?: unknown; lead_investor?: boolean; side_letter_document_id?: unknown; wire_received_at?: unknown }>;
mfn_holders?: Array<string>;
closing_conditions?: Array<{ kind: "legal_opinion_delivered" | "charter_amendment_filed" | "indemnification_refreshed" | "director_officer_questionnaires" | "five_percent_holder_questionnaires" | "accredited_investor_certifications" | "blue_sky_filings" | "form_d_filed" | "regulatory_approval" | "third_party_consents" | "good_standing_certificates" | "lien_searches" | "kyc_aml_clearance" | "signing_envelopes_executed" | "wire_funding_received" | "equity_plan_pool_increase" | "custom"; description?: string; due_date?: unknown; owner_stakeholder_id?: unknown; status: "open" | "in_progress" | "satisfied" | "waived" | "blocked"; satisfied_at?: unknown; waiver_document_id?: unknown; cleansing_vote_resolution_id?: unknown }>;
governing_documents?: { spa_id?: unknown; ira_id?: unknown; voting_agreement_id?: unknown; rofr_co_sale_id?: unknown; management_rights_letters?: Array<{ investor_stakeholder_id: string; document_id: string }>; legal_opinion_id?: unknown; restated_certificate_filing_id?: unknown; form_d_filing_id?: unknown; indemnification_agreement_ids?: Array<string> };
post_close_governance?: { board_composition?: { common_seats?: number; preferred_seats?: number; mutual_seats?: number; observer_seats?: number }; drag_along?: { preferred_threshold_percent?: number; common_threshold_percent?: number; applies_to_share_class_ids?: Array<string> }; registration_rights?: { demand_count?: number; piggyback?: boolean; s3_demands_per_year?: number; expense_cap_cents?: unknown }; information_rights?: { financial_statements_frequency?: "monthly" | "quarterly" | "annually" | "none"; budget_required?: boolean; inspection_rights?: boolean; observer_rights?: boolean }; pro_rata_rights?: { major_investor_threshold_cents?: unknown; applies_to_all_investors?: boolean }; transfer_restrictions?: { rofr_holder?: "company" | "investors" | "both"; co_sale_applies?: boolean; lock_up_months?: unknown } };
qualified_financing_for_safes?: boolean;
authorizing_resolution_id?: unknown;
document_ids?: Array<string>;
signing_date?: unknown;
closing_date?: unknown;
partial_closes?: Array<{ closing_date?: string; investor_ids?: Array<string>; amount_recognized?: MonetaryAmount }>;
pre_close_snapshot_id?: unknown;
post_close_snapshot_id?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}ShareClass
Typed-ID prefix cls_. A class of shares authorized for an entity (Common, Series Seed, Series A, etc.).
/** A class of shares authorized for an entity (Common, Series Seed, Series A, etc.). */
export interface ShareClass {
id: string;
object: "share_class";
entity_id: string;
name: string;
kind?: "common" | "preferred";
series?: unknown;
authorized: number;
issued: number;
par_value: MonetaryAmount;
liquidation_preference?: unknown;
conversion_rights?: Record<string, unknown>;
voting_rights?: Record<string, unknown>;
certificate_of_designations_document_id?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}ShareLedgerEntry
Typed-ID prefix led_. One entry per equity event. Covers traditional share mutations
/** One entry per equity event. Covers traditional share mutations */
export interface ShareLedgerEntry {
id: string;
object: "share_ledger_entry";
entity_id: string;
kind: "issuance" | "transfer" | "cancellation" | "repurchase" | "founder_repurchase_to_treasury" | "safe_grant" | "safe_conversion" | "note_grant" | "note_conversion" | "liquidating_distribution" | "liquidation_preference_payout" | "convertible_cancellation";
share_class_id?: unknown;
from_stakeholder_id?: unknown;
to_stakeholder_id?: unknown;
quantity?: unknown;
price_per_share?: MonetaryAmount;
consideration?: string;
certificate_number?: unknown;
transaction_date: string;
principal_amount?: MonetaryAmount | unknown;
safe_type?: "pre_money" | "post_money" | "post_money_capped" | "mfn_only" | null;
safe_money_position?: "pre_money" | "post_money" | null;
safe_variant?: "cap_only" | "discount_only" | "cap_and_discount" | "mfn_only" | null;
safe_jurisdiction?: "us" | "canada" | "cayman" | "singapore" | null;
pro_rata_rights?: unknown;
qualifying_financing_threshold_cents?: unknown;
mfn?: unknown;
mfn_window_months?: unknown;
mfn_amendments?: Array<{ triggered_by_entry_id: string; amendment_document_id?: unknown; amended_at: number }>;
interest_rate?: unknown;
discount_rate?: unknown;
valuation_cap?: MonetaryAmount | unknown;
maturity_date?: unknown;
references_entry_id?: unknown;
document_ids?: Array<string>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}SideLetter
Typed-ID prefix sl_. Investor side letter granting individual rights beyond the standard
/** Investor side letter granting individual rights beyond the standard */
export interface SideLetter {
id: string;
object: "side_letter";
entity_id: string;
parent: { kind: "convertible" | "round" | "corporate_transaction"; id: string };
investor_stakeholder_id: string;
clauses: Array<{ kind: "information_rights" | "inspection_rights" | "board_observer" | "mfn" | "registration_rights" | "pro_rata_rights" | "redemption_rights" | "transfer_restriction_waiver" | "drag_along_carveout" | "veto_rights" | "notice_rights" | "custom"; information_rights?: unknown; board_observer?: unknown; mfn?: unknown; pro_rata_rights?: unknown; registration_rights?: unknown; redemption_rights?: unknown; transfer_restriction_waiver?: unknown; custom?: unknown }>;
document_id?: unknown;
envelope_id?: unknown;
signed_at?: unknown;
status: "draft" | "sent" | "executed" | "terminated" | "void";
terminated_at?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}SigningEnvelope
Typed-ID prefix env_. Coordinates multi-party signing of one or more Documents. Per-document
/** Coordinates multi-party signing of one or more `Document`s. Per-document */
export interface SigningEnvelope {
id: string;
object: "signing_envelope";
entity_id: string;
subject?: string;
document_ids: Array<string>;
signers: Array<EnvelopeSigner>;
routing: "parallel" | "sequential";
status: "draft" | "sent" | "completed" | "declined" | "expired" | "voided";
sent_at?: unknown;
completed_at?: unknown;
expires_at?: unknown;
last_reminder_at?: unknown;
reminder_policy?: { interval_hours?: number; max_reminders?: number };
message?: string;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}SigningSession
Typed-ID prefix sig_. Short-lived bearer for human-signature-over-API (Rail 1, Shape 2). Issued via
/** Short-lived bearer for human-signature-over-API (Rail 1, Shape 2). Issued via */
export interface SigningSession {
id: string;
object: "signing_session";
target: { document_id?: unknown; signing_envelope_id?: unknown; signer_id?: unknown };
stakeholder_id: string;
human_clerk_user_id: string;
created_at: number;
expires_at: number;
status: "pending" | "consumed" | "expired" | "revoked";
signature_token?: unknown;
disclosure_packet_hash?: string;
livemode: boolean;
}Stakeholder
Typed-ID prefix stk_. A person (or another entity) associated with a Matter entity. Roles are an array —
/** A person (or another entity) associated with a Matter entity. Roles are an array — */
export interface Stakeholder {
id: string;
object: "stakeholder";
entity_id: string;
kind: "natural_person" | "entity";
name: string;
contact?: { email?: string; phone?: string; address?: Address };
tax_id?: string;
residency?: string;
date_of_birth?: unknown;
residential_address?: Address | unknown;
identification?: unknown;
boi_eligibility?: "ready" | "missing_fields" | "not_applicable";
boi_missing_fields?: Array<"date_of_birth" | "residential_address" | "identification.type" | "identification.number" | "identification.jurisdiction" | "identification.image_document_id">;
beneficial_owner_percentage?: unknown;
voting_percentage?: unknown;
cap_table_percentage?: unknown;
boi_filing_status?: "not_required" | "pending" | "filed" | "exempt" | "amended_required";
experience_level?: "novice" | "technical" | "serial";
accredited_investor_status?: "unknown" | "self_certified" | "verified" | "not_accredited";
five_percent_holder?: boolean;
ip_assignment_scope?: "full" | "limited" | "none" | "not_applicable";
consideration_for_initial_shares?: null | "cash" | "ip_assignment" | "services" | "mixed";
signed_artifacts?: Array<{ document_id: string; type: string; executed_at: number; role?: string }>;
status?: "active" | "separating" | "separated" | "separated_to_acquirer";
roles: Array<{ type: "founder" | "officer" | "director" | "shareholder" | "optionholder" | "manager" | "member"; title?: string; start_date: string; end_date?: unknown; resolution_id?: unknown }>;
residence_state?: unknown;
marital_status?: "single" | "married" | "domestic_partnership_with_cp" | "separated" | "divorced" | "widowed" | "unknown";
spouse_id?: unknown;
spouse_name?: unknown;
spouse_tax_id_token?: unknown;
separated_at?: unknown;
separation_kind?: null | "voluntary_pre_cliff" | "voluntary_post_cliff" | "involuntary" | "mutual";
separation_reason?: unknown;
transitioned_to_acquirer_id?: unknown;
community_property_state_at_grant?: unknown;
metadata?: Metadata;
created: number;
updated: number;
livemode: boolean;
}StakeholderPortalSession
Typed-ID prefix sps_. Hosted URL where a stakeholder accepts grants, signs 83(b) elections, downloads
/** Hosted URL where a stakeholder accepts grants, signs 83(b) elections, downloads */
export interface StakeholderPortalSession {
id: string;
object: "stakeholder_portal_session";
stakeholder_id: string;
url: string;
return_url: string;
scope: Array<"grants" | "documents" | "vesting" | "tax_elections" | "cap_table_view">;
metadata?: Metadata;
expires_at: number;
created: number;
livemode: boolean;
}StateRegistration
Typed-ID prefix reg_. State-level registration filed via the registered-agent partner.
/** State-level registration filed via the registered-agent partner. */
export interface StateRegistration {
object: "state_registration";
id: string;
entity_id: string;
registration_kind: "employer" | "sales_tax" | "dba" | "business_license";
agency?: null | "dol" | "edd" | "dir" | "dtf" | "twc" | "revenue_department" | "tax_division" | "secretary_of_state" | "other";
agency_account_kind?: null | "ui" | "withholding" | "combined" | "workers_comp" | "etu" | "reemployment_tax" | "sales_use_tax";
jurisdiction: { state?: string; county?: unknown; city?: unknown };
status: "pending" | "confirmed" | "lapsed" | "closing" | "closed" | "withdrawn";
effective_date: string;
confirmed_at?: unknown;
closed_at?: unknown;
closure_status?: unknown;
state_account_number?: unknown;
trade_name?: unknown;
trigger?: null | "first_hire_in_state" | "first_revenue_in_state" | "voluntary" | "threshold_crossed";
registered_agent_partner_id?: unknown;
obligations?: Array<{ form_code: string; period_kind: "monthly" | "quarterly" | "annual" | "terminating"; due_at: string; agency: string; filing_id?: unknown }>;
}SubAgentSession
Typed-ID prefix sas_. Async wrapper for a government or partner web interface that doesn't
/** Async wrapper for a government or partner web interface that doesn't */
export interface SubAgentSession {
id: string;
object: "sub_agent_session";
status: "pending" | "running" | "completed" | "failed" | "cancelled";
target_resource: { kind: "filing" | "boi_evaluation" | "bank_account" | "document" | "ein_application" | "foreign_qualification"; id: string };
agent_kind: "de_sos_filer" | "fincen_boir_filer" | "irs_mef_filer" | "irs_id_me_efiler" | "irs_ss4_filer" | "mercury_onboarding" | "brex_onboarding" | "state_sos_qualification";
target_url?: string;
created_at: string;
started_at?: string;
completed_at?: string;
outcome?: { confirmation_number?: string; receipt_document_id?: string; error_kind?: string; error_detail?: string };
actions_taken?: Array<{ at?: string; step?: string; detail?: string }>;
livemode?: boolean;
}TaxElection
Typed-ID prefix txe_. A tax election filed for an entity (S-Corp, §83(b), check-the-box, late-election
/** A tax election filed for an entity (S-Corp, §83(b), check-the-box, late-election */
export interface TaxElection {
id: string;
object: "tax_election";
entity_id: string;
kind: "s_corp" | "section_83b" | "check_the_box" | "late_election_relief" | "qsbs_attestation" | "accounting_method_change" | "consolidated_return_election" | "extension_request";
status: "pending" | "filed" | "accepted" | "rejected";
effective_date: string;
filing_id?: unknown;
document_id?: unknown;
grant_id?: unknown;
share_lot_id?: unknown;
qsbs?: unknown;
target_classification?: "c_corporation" | "partnership" | "disregarded_entity" | null;
shareholder_consents?: Array<string>;
original_election_kind?: "s_corp" | "qsub" | "esbt" | "qsst" | null;
reason_for_failure?: unknown;
rejection_reason?: unknown;
accepted_at?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}TaxProfile
Typed-ID prefix tax_. Tax identifiers and elections for an entity. Election state mirrors filings
/** Tax identifiers and elections for an entity. Election state mirrors filings */
export interface TaxProfile {
id: string;
object: "tax_profile";
entity_id: string;
ein?: unknown;
state_tax_ids?: Record<string, string>;
s_corp_election_status?: "none" | "filed" | "accepted";
fiscal_year_end?: string;
accounting_method?: null | "cash" | "accrual" | "hybrid";
first_taxable_year_end?: unknown;
boi_filing_status?: "not_required" | "pending" | "filed" | "exempt" | "amended_required";
elections?: Array<TaxElection>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}Template
Typed-ID prefix ``. Metadata for a Matter-authored document template that
/** Metadata for a Matter-authored document template that */
export interface Template {
object: "template";
template_id: string;
name: string;
kind: string;
category: "formation" | "financing" | "commercial" | "governance" | "tax";
version: string;
availability: "preview" | "ga" | "deprecated" | "retired";
successor_template_id?: unknown;
cover_page_field_schema?: unknown;
attachable_to?: Array<string>;
}TemplateClause
Typed-ID prefix tcl_. Content-addressed clause node. The position field encodes the
/** Content-addressed clause node. The `position` field encodes the */
export interface TemplateClause {
object: "template_clause";
id: string;
revision_id: string;
parent_clause_id?: unknown;
body_mdx_fragment: string;
position: Record<string, unknown>;
content_sha256: string;
is_attribution_node?: boolean;
template_source_id?: unknown;
}TemplateRenderJob
Typed-ID prefix trj_. Queued render execution. Drained by the existing BackgroundJob +
/** Queued render execution. Drained by the existing BackgroundJob + */
export interface TemplateRenderJob {
object: "template_render_job";
id: string;
template_id: string;
template_revision_id: string;
entity_id: string;
org_id: string;
jurisdiction: string;
overlay_hash: string;
render_fingerprint: string;
authorizing_token_id: string;
mode: "live" | "sandbox" | "test";
status: "queued" | "rendering" | "succeeded" | "failed";
document_id?: unknown;
error?: unknown;
queued_at: string;
started_at?: unknown;
completed_at?: unknown;
render_region?: string;
}TemplateRevision
Typed-ID prefix trv_. Immutable content-addressed snapshot of a template at a specific
/** Immutable content-addressed snapshot of a template at a specific */
export interface TemplateRevision {
object: "template_revision";
id: string;
template_id: string;
version: string;
sha256: string;
manifest: Record<string, unknown>;
availability: "preview" | "ga" | "deprecated" | "retired";
visibility: "platform" | "org_private" | "published";
publisher_org_id?: unknown;
parent_revision_id?: unknown;
mode: "live" | "sandbox" | "test";
source_id?: unknown;
created: string;
created_by_token_id?: unknown;
}TemplateSource
Typed-ID prefix tsr_. Upstream-repo provenance for ingested templates. commit_sha is
/** Upstream-repo provenance for ingested templates. `commit_sha` is */
export interface TemplateSource {
object: "template_source";
id: string;
repo_url: string;
commit_sha: string;
license: string;
attribution_text?: unknown;
ingested_at: string;
normalizer_version: string;
}TestClock
Typed-ID prefix clk_. A simulated wall-clock for test-mode entities. Attach entities via
/** A simulated wall-clock for test-mode entities. Attach entities via */
export interface TestClock {
id: string;
object: "test_clock";
name?: unknown;
frozen_time: number;
status: "ready" | "advancing" | "failed";
attached_entity_count?: number;
metadata?: Metadata;
created: number;
updated?: number;
livemode: boolean;
}Token
Typed-ID prefix tok_. Scoped access token. sk_live_ / sk_test_ / pk_live_ / pk_test_ are special
/** Scoped access token. `sk_live_` / `sk_test_` / `pk_live_` / `pk_test_` are special */
export interface Token {
id: string;
object: "token";
tier: 1 | 2 | 3 | 4;
scopes?: Array<{ allow?: Array<string>; deny?: Array<string>; resources?: Array<string>; conditions?: Record<string, unknown> }>;
principal: { human_id: string; agent_id?: unknown };
portfolio_id?: unknown;
limits?: { max_spend_per_month?: MonetaryAmount; allowed_filing_types?: Array<string>; frequency_caps?: Record<string, { per_day?: number; per_month?: number }> };
allowance?: unknown;
api_version: string;
revoked_at?: unknown;
last_used_at?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}TopUp
Typed-ID prefix tpu_. One prepaid credit purchase. Created in pending with a hosted checkout
/** One prepaid credit purchase. Created in `pending` with a hosted checkout */
export interface TopUp {
id: string;
object: "top_up";
account_id: string;
amount: MonetaryAmount;
status: "pending" | "succeeded" | "failed" | "expired" | "refunded";
initiator: "human" | "auto_recharge" | "agent";
checkout_url?: unknown;
payment_method_type?: unknown;
failure_code?: unknown;
ledger_entry_id?: unknown;
created: number;
updated: number;
livemode: boolean;
}Trademark
Typed-ID prefix tmk_. A USPTO trademark application or registration for a mark used by
/** A USPTO trademark application or registration for a mark used by */
export interface Trademark {
object: "trademark";
id: string;
entity_id: string;
mark: string;
drawing_kind?: "standard_character" | "special_form";
drawing_file_id?: unknown;
classes: Array<{ class_number?: number; identification?: string; identification_source?: "acceptable_id_manual" | "custom" }>;
jurisdiction: "US";
basis_of_filing: "actual_use" | "intent_to_use";
status: "pending_filing" | "filed" | "published_for_opposition" | "opposed" | "notice_of_allowance" | "registered" | "abandoned" | "cancelled" | "expired";
first_use_date?: unknown;
first_use_in_commerce_date?: unknown;
specimen_file_id?: unknown;
serial_number?: unknown;
registration_number?: unknown;
filed_at?: unknown;
published_at?: unknown;
notice_of_allowance_at?: unknown;
registered_at?: unknown;
related_search_id?: unknown;
application_attributes?: { has_custom_identification?: boolean; additional_classes_count?: number; claims_prior_registration?: boolean; estimated_fee_usd_cents?: number };
statement_of_use?: unknown;
maintenance_obligations?: Array<{ declaration_kind?: "section_8" | "section_8_and_9" | "section_15"; window_start?: string; window_end?: string; filed_at?: unknown; status?: "upcoming" | "in_window" | "filed" | "missed" }>;
related_document_id?: unknown;
partner_filing_id?: unknown;
}TrademarkSearch
Typed-ID prefix tms_. A USPTO TESS search snapshot for a proposed mark + class combination.
/** A USPTO TESS search snapshot for a proposed mark + class combination. */
export interface TrademarkSearch {
object: "trademark_search";
id: string;
entity_id: string;
mark: string;
classes: Array<number>;
jurisdiction: "US";
search_date: string;
result: "clear" | "minor_conflicts" | "blocking_conflicts";
conflicts?: Array<{ conflicting_mark?: string; conflicting_serial_number?: string; conflicting_classes?: Array<number>; conflicting_status?: "pending" | "registered" | "abandoned"; severity?: "minor" | "blocking" }>;
snapshot_url?: string;
}Transfer
Typed-ID prefix xfr_. Money movement on a BankAccount — outgoing (initiated via
/** Money movement on a BankAccount — outgoing (initiated via */
export interface Transfer {
object: "transfer";
id: string;
bank_account_id: string;
transfer_kind: "ach_credit" | "ach_debit" | "domestic_wire" | "international_wire" | "check_issued" | "check_deposited" | "ach_received" | "wire_received";
direction: "incoming" | "outgoing";
amount_usd_cents: number;
status: "pending" | "completed" | "failed" | "returned";
counterparty?: Record<string, unknown>;
memo?: unknown;
authorizing_stakeholder_id?: unknown;
initiated_at?: string;
completed_at?: unknown;
partner_transfer_id?: unknown;
}TransferAgent
Typed-ID prefix ta_. A third-party transfer agent engaged to manage share certificates,
/** A third-party transfer agent engaged to manage share certificates, */
export interface TransferAgent {
id: string;
object: "transfer_agent";
entity_id: string;
provider: "computershare" | "vstock" | "ast" | "equiniti" | "broadridge" | "other";
provider_external_account_id: string;
engaged_at: string;
disengaged_at?: unknown;
status: "engaged" | "disengaged" | "transitioning";
last_reconciliation_audit_id?: unknown;
metadata?: Metadata;
created_at: string;
updated_at: string;
livemode: boolean;
}TransferAgentReconciliationAudit
Typed-ID prefix tar_. The result of a single reconciliation pass between the transfer
/** The result of a single reconciliation pass between the transfer */
export interface TransferAgentReconciliationAudit {
id: string;
object: "transfer_agent_reconciliation_audit";
transfer_agent_id: string;
entity_id: string;
audit_kind: "routine" | "pre_close" | "post_close" | "dispute";
as_of_date: string;
status: "pending" | "completed" | "discrepancies_found" | "failed";
discrepancies: Array<{ discrepancy_kind: "cert_count_mismatch" | "holder_name_mismatch" | "vesting_state_mismatch" | "strike_price_mismatch" | "class_mismatch" | "other"; affected_grant_id?: unknown; affected_holder_stakeholder_id?: unknown; transfer_agent_record: string; matter_record: string; severity: "low" | "medium" | "high"; resolution_status: "unresolved" | "resolved_via_grant_amendment" | "resolved_via_share_ledger_correction" | "resolved_via_cancel_and_reissue" | "accepted_as_is" }>;
resolution_completed_at?: unknown;
metadata?: Metadata;
created_at: string;
updated_at: string;
livemode: boolean;
}Valuation
Typed-ID prefix val_. 409A valuation event. Compliance tracks expires_at.
/** 409A valuation event. Compliance tracks `expires_at`. */
export interface Valuation {
id: string;
object: "valuation";
entity_id: string;
fair_market_value_per_share: MonetaryAmount;
provider?: string;
methodology?: string;
effective_date: string;
expires_at: string;
report_document_id?: unknown;
is_safe_harbor_current?: boolean;
material_event_triggered_at?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}VestingOverlay
Typed-ID prefix vov_. Retroactive vesting layer applied to previously-issued shares. Created
/** Retroactive vesting layer applied to previously-issued shares. Created */
export interface VestingOverlay {
id: string;
object: "vesting_overlay";
entity_id: string;
ledger_entry_id: string;
grant_id: unknown;
vesting_schedule: { cliff_months?: number; total_months?: number; granularity?: "monthly" | "quarterly" | "annually"; commencement_date?: string };
authorizing_resolution_id: string;
tax_election_acknowledgement?: { acknowledged_implications: boolean; decision: "file_new_83b" | "rely_on_original" | "decline_no_filing"; new_83b_document_id?: unknown };
effective_date: string;
document_id?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}WebhookEndpoint
Typed-ID prefix whe_. A subscription target for events. Pins an api_version at creation; payloads never
/** A subscription target for events. Pins an `api_version` at creation; payloads never */
export interface WebhookEndpoint {
id: string;
object: "webhook_endpoint";
url: string;
description?: string;
enabled_events: Array<string>;
api_version: string;
include?: Array<"data.object">;
portfolio_id?: unknown;
signing_secret?: string;
status: "enabled" | "disabled";
last_delivery?: unknown;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}WindDownReserve
Typed-ID prefix wdr_. DGCL §281(b)(iii) reserve. Cash set aside during a wind-down to cover
/** DGCL §281(b)(iii) reserve. Cash set aside during a wind-down to cover */
export interface WindDownReserve {
object: "wind_down_reserve";
id: string;
entity_id: string;
creditor_claim_id: string;
creditor_claims_window_id?: string;
kind?: "general_reserve" | "creditor_settlement_buffer" | "insolvency_security";
court_petition_id?: unknown;
held_amount_usd: number;
released_amount_usd?: number;
status: "held" | "partially_released" | "closed";
authorizing_resolution_id?: string;
opened_at?: number;
closed_at?: unknown;
created: number;
updated: number;
livemode: boolean;
}Workspace
Typed-ID prefix wsp_. Pre-entity container — created BEFORE the entity exists. Holds the document vault,
/** Pre-entity container — created BEFORE the entity exists. Holds the document vault, */
export interface Workspace {
id: string;
object: "workspace";
name: string;
status: "provisioning" | "ready" | "active" | "archived";
archived_at?: unknown;
entity_ids: Array<string>;
metadata?: Metadata;
created?: number;
updated?: number;
livemode: boolean;
}