SDKs · Go
Type reference (Go)
Go type signatures for every Matter resource. Generated from the canonical OpenAPI spec.
Last updated
github.com/mattermode/matter-go ships these as exported structs with JSON
tags. Optional fields use ,omitempty so omitted values round-trip cleanly
through the API.
Field names follow Go's PascalCase convention; JSON tags preserve the snake_case wire format.
Account
Typed-ID prefix acct_. The API customer. Top-level identity owning tokens, portfolios, and entities.
// Account — The API customer. Top-level identity owning tokens, portfolios, and entities.
type Account struct {
Id string `json:"id"`
Object string `json:"object"`
LegalName string `json:"legal_name"`
BillingEmail string `json:"billing_email,omitempty"`
BillingAddress Address `json:"billing_address,omitempty"`
DefaultJurisdiction Jurisdiction `json:"default_jurisdiction,omitempty"`
DefaultRegisteredAgentProvider string `json:"default_registered_agent_provider,omitempty"`
DefaultSigningMethod string `json:"default_signing_method,omitempty"`
TierMax int64 `json:"tier_max,omitempty"`
ActiveAgentPolicyId any `json:"active_agent_policy_id,omitempty"`
PortfolioIds []string `json:"portfolio_ids,omitempty"`
PrimaryPrincipalUserId any `json:"primary_principal_user_id,omitempty"`
Soc2AttestationStatus string `json:"soc2_attestation_status,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}AgentPolicy
Typed-ID prefix pol_. Versioned governance record of what agent tokens may do. Authorizations are
// AgentPolicy — Versioned governance record of what agent tokens may do. Authorizations are
type AgentPolicy struct {
Id string `json:"id"`
Object string `json:"object"`
Name string `json:"name"`
TierMax int64 `json:"tier_max"`
Version int64 `json:"version"`
Active bool `json:"active"`
AllowedEndpoints []string `json:"allowed_endpoints,omitempty"`
DeniedEndpoints []string `json:"denied_endpoints,omitempty"`
Resources []string `json:"resources,omitempty"`
Conditions map[string]any `json:"conditions,omitempty"`
RequireHumanSignatureFor []string `json:"require_human_signature_for,omitempty"`
StandingAcknowledgements []AcknowledgementSlug `json:"standing_acknowledgements,omitempty"`
SpendLimitPerPeriod map[string]any `json:"spend_limit_per_period,omitempty"`
EscalationEmail string `json:"escalation_email,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}AuditEntry
Typed-ID prefix aud_. Immutable record of a state-changing action. One per transition. Signature-producing
// AuditEntry — Immutable record of a state-changing action. One per transition. Signature-producing
type AuditEntry struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId any `json:"entity_id"`
Actor map[string]any `json:"actor"`
Action string `json:"action"`
Before any `json:"before,omitempty"`
After map[string]any `json:"after,omitempty"`
RequestId string `json:"request_id,omitempty"`
Ip string `json:"ip,omitempty"`
OccurredAt int64 `json:"occurred_at"`
Livemode bool `json:"livemode"`
}Authorization
Typed-ID prefix azn_. First-class async pause. When a tier-3 action requires human signature, the API
// Authorization — First-class async pause. When a tier-3 action requires human signature, the API
type Authorization struct {
Id string `json:"id"`
Object string `json:"object"`
TokenId string `json:"token_id"`
Action string `json:"action"`
PayloadHash string `json:"payload_hash"`
Status string `json:"status"`
ExpiresAt int64 `json:"expires_at"`
SignatureUrl string `json:"signature_url,omitempty"`
ApprovedByStakeholderId any `json:"approved_by_stakeholder_id,omitempty"`
ApprovedAt any `json:"approved_at,omitempty"`
DeniedReason any `json:"denied_reason,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}BankAccount
Typed-ID prefix bka_. Deposit account for an entity. Opened via createBankAccount,
// BankAccount — Deposit account for an entity. Opened via `createBankAccount`,
type BankAccount struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
Status string `json:"status"`
AccountType string `json:"account_type"`
Nickname string `json:"nickname"`
BalanceUsdCents int64 `json:"balance_usd_cents"`
Provider string `json:"provider,omitempty"`
AccountNumber string `json:"account_number,omitempty"`
RoutingNumber any `json:"routing_number,omitempty"`
AccountNumberLast_4 any `json:"account_number_last_4,omitempty"`
KybDecision string `json:"kyb_decision,omitempty"`
KybDecidedAt string `json:"kyb_decided_at,omitempty"`
ColumnAccountId string `json:"column_account_id,omitempty"`
SubAgentSessionId string `json:"sub_agent_session_id,omitempty"`
PartnerBank string `json:"partner_bank,omitempty"`
AuthorizedSignerStakeholderIds []string `json:"authorized_signer_stakeholder_ids,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
ActivatedAt any `json:"activated_at,omitempty"`
}BenefitPlan
Typed-ID prefix bp_. Linkage record for an entity's benefit plan or insurance policy.
// BenefitPlan — Linkage record for an entity's benefit plan or insurance policy.
type BenefitPlan struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
Regime string `json:"regime"`
ProviderKind string `json:"provider_kind"`
ProviderName any `json:"provider_name,omitempty"`
ExternalAccountId any `json:"external_account_id,omitempty"`
LinkageAttestationDocumentId any `json:"linkage_attestation_document_id,omitempty"`
AdoptionResolutionId any `json:"adoption_resolution_id,omitempty"`
TerminationResolutionId any `json:"termination_resolution_id,omitempty"`
PlanAdministratorStakeholderId any `json:"plan_administrator_stakeholder_id,omitempty"`
Status string `json:"status"`
OpenedAt int64 `json:"opened_at,omitempty"`
TerminatingAt any `json:"terminating_at,omitempty"`
TerminatedAt any `json:"terminated_at,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}BillingAlert
Typed-ID prefix alrt_. A billing tripwire. Alerts notify — via billing.alert.fired events and an
// BillingAlert — A billing tripwire. Alerts notify — via `billing.alert.fired` events and an
type BillingAlert struct {
Id string `json:"id"`
Object string `json:"object"`
AccountId string `json:"account_id"`
Metric string `json:"metric"`
ThresholdValue int64 `json:"threshold_value"`
Unit any `json:"unit,omitempty"`
Recurrence string `json:"recurrence"`
Status string `json:"status"`
IsDefault bool `json:"is_default"`
LastFiredAt any `json:"last_fired_at,omitempty"`
WebhookEndpointId any `json:"webhook_endpoint_id,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}BrowserAgentRun
Typed-ID prefix bar_. A read-only summary of one fill-no-submit browser-agent run preparing a
// BrowserAgentRun — A read-only summary of one fill-no-submit browser-agent run preparing a
type BrowserAgentRun struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
FilingKind string `json:"filing_kind"`
Submitted bool `json:"submitted"`
State string `json:"state"`
PerceptionMode string `json:"perception_mode,omitempty"`
Region string `json:"region,omitempty"`
ComputedFeeUsd any `json:"computed_fee_usd,omitempty"`
ObservedFeeUsd any `json:"observed_fee_usd,omitempty"`
ProofBundleId any `json:"proof_bundle_id,omitempty"`
ContentHash any `json:"content_hash,omitempty"`
RenderHash any `json:"render_hash,omitempty"`
Blocker any `json:"blocker,omitempty"`
StoppedAt any `json:"stopped_at,omitempty"`
Created int64 `json:"created"`
}Budget
Typed-ID prefix bud_. A per-period spend fence over an org, portfolio, or token. A block budget
// Budget — A per-period spend fence over an org, portfolio, or token. A `block` budget
type Budget struct {
Id string `json:"id"`
Object string `json:"object"`
ScopeKind string `json:"scope_kind"`
ScopeId any `json:"scope_id,omitempty"`
Period string `json:"period"`
Cap MonetaryAmount `json:"cap"`
Action string `json:"action"`
CreatedByUserId any `json:"created_by_user_id,omitempty"`
CreatedByTokenId any `json:"created_by_token_id,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}CapTableSnapshot
Typed-ID prefix cts_. Materialized point-in-time cap table, pinned at meaningful moments (priced
// CapTableSnapshot — Materialized point-in-time cap table, pinned at meaningful moments (priced
type CapTableSnapshot struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
AsOf int64 `json:"as_of"`
Reason string `json:"reason"`
CapTable CapTable `json:"cap_table"`
DocumentId any `json:"document_id,omitempty"`
ValuationId any `json:"valuation_id,omitempty"`
ActorId any `json:"actor_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Livemode bool `json:"livemode"`
}CorporateTransaction
Typed-ID prefix ctx_. M&A envelope — merger, acquisition, asset sale, stock sale, conversion, or
// CorporateTransaction — M&A envelope — merger, acquisition, asset sale, stock sale, conversion, or
type CorporateTransaction struct {
Id string `json:"id"`
Object string `json:"object"`
Kind string `json:"kind"`
Parties []map[string]any `json:"parties"`
Stage string `json:"stage"`
Consideration map[string]any `json:"consideration,omitempty"`
ConsiderationBreakdown map[string]any `json:"consideration_breakdown,omitempty"`
AuthorizingResolutionId any `json:"authorizing_resolution_id,omitempty"`
EffectiveDate any `json:"effective_date,omitempty"`
SigningDate any `json:"signing_date,omitempty"`
ClosingDate any `json:"closing_date,omitempty"`
Treatment map[string]any `json:"treatment,omitempty"`
HsrRequired bool `json:"hsr_required,omitempty"`
RegulatoryApprovals []map[string]any `json:"regulatory_approvals,omitempty"`
Section_280gAnalysis map[string]any `json:"section_280g_analysis,omitempty"`
DocumentIds []string `json:"document_ids,omitempty"`
EscrowIds []string `json:"escrow_ids,omitempty"`
EarnOutIds []string `json:"earn_out_ids,omitempty"`
IndemnityClaimIds []string `json:"indemnity_claim_ids,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}CourtOrder
Typed-ID prefix co_. A court order recorded against a CourtPetition. Captures the
// CourtOrder — A court order recorded against a `CourtPetition`. Captures the
type CourtOrder struct {
Object string `json:"object"`
Id string `json:"id"`
CourtPetitionId string `json:"court_petition_id"`
EntityId string `json:"entity_id"`
OrderKind string `json:"order_kind"`
CourtApprovedSecurityAmountCents int64 `json:"court_approved_security_amount_cents"`
ApprovedDistributionPlan map[string]any `json:"approved_distribution_plan"`
EffectiveDate string `json:"effective_date"`
OrderDocumentId string `json:"order_document_id"`
ChanceryDocketNumber any `json:"chancery_docket_number,omitempty"`
AppealableUntil any `json:"appealable_until,omitempty"`
Judge any `json:"judge,omitempty"`
RecordedAt int64 `json:"recorded_at"`
Created int64 `json:"created"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
Metadata Metadata `json:"metadata,omitempty"`
}CourtPetition
Typed-ID prefix cp_. Verified petition filed with a court of competent jurisdiction in
// CourtPetition — Verified petition filed with a court of competent jurisdiction in
type CourtPetition struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
PetitionKind string `json:"petition_kind"`
Status string `json:"status"`
ClaimsSummary []map[string]any `json:"claims_summary"`
ContingentReservesSchedule []map[string]any `json:"contingent_reserves_schedule"`
ProposedDistributionPlan map[string]any `json:"proposed_distribution_plan"`
AffidavitDocumentIds []string `json:"affidavit_document_ids"`
AuthorizingResolutionId any `json:"authorizing_resolution_id,omitempty"`
Court any `json:"court,omitempty"`
ChanceryDocketNumber any `json:"chancery_docket_number,omitempty"`
CourtDocketUrl any `json:"court_docket_url,omitempty"`
FiledWithMatterAt any `json:"filed_with_matter_at,omitempty"`
FiledWithCourtAt any `json:"filed_with_court_at,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
Metadata Metadata `json:"metadata,omitempty"`
}CreditorClaimsWindow
Typed-ID prefix ccw_. Statutory creditor-notice window run during dissolution under DGCL
// CreditorClaimsWindow — Statutory creditor-notice window run during dissolution under DGCL
type CreditorClaimsWindow struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
Procedure string `json:"procedure"`
StatutoryWindowDays int64 `json:"statutory_window_days,omitempty"`
PublicationDate any `json:"publication_date,omitempty"`
OpenedAt any `json:"opened_at,omitempty"`
ClosesAt any `json:"closes_at,omitempty"`
ClosedAt any `json:"closed_at,omitempty"`
Status string `json:"status"`
KnownCreditors []map[string]any `json:"known_creditors,omitempty"`
PublicationRecords []map[string]any `json:"publication_records,omitempty"`
ClaimsReceived []map[string]any `json:"claims_received,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}DataRoom
Typed-ID prefix dro_. Permissioned virtual data room scoped to a corporate transaction. Counterparty
// DataRoom — Permissioned virtual data room scoped to a corporate transaction. Counterparty
type DataRoom struct {
Id string `json:"id"`
Object string `json:"object"`
TransactionId string `json:"transaction_id"`
Name string `json:"name"`
Status string `json:"status"`
ExpiresAt any `json:"expires_at,omitempty"`
WatermarkEmail bool `json:"watermark_email"`
DocumentIds []string `json:"document_ids,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Director
Typed-ID prefix dir_. Canonical director record. Created by changeDirector (action: elect)
// Director — Canonical director record. Created by `changeDirector` (action: elect)
type Director struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
StakeholderId string `json:"stakeholder_id"`
BoardSeat int64 `json:"board_seat,omitempty"`
Status string `json:"status"`
EffectiveDate string `json:"effective_date"`
ElectedViaResolutionId string `json:"elected_via_resolution_id,omitempty"`
RemovedViaResolutionId string `json:"removed_via_resolution_id,omitempty"`
Livemode bool `json:"livemode,omitempty"`
}Document
Typed-ID prefix doc_. Legal document. Dual artifact — structured JSON (GET /documents/{id}) and rendered
// Document — Legal document. Dual artifact — structured JSON (`GET /documents/{id}`) and rendered
type Document struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Type string `json:"type"`
Provenance string `json:"provenance,omitempty"`
Status string `json:"status"`
ExecutionStatus string `json:"execution_status"`
LifecycleClass string `json:"lifecycle_class,omitempty"`
UpstreamProvenance any `json:"upstream_provenance,omitempty"`
TerminatedAt any `json:"terminated_at,omitempty"`
TerminatedReason any `json:"terminated_reason,omitempty"`
ClauseToggles []map[string]any `json:"clause_toggles,omitempty"`
ClauseToggleChanges []map[string]any `json:"clause_toggle_changes,omitempty"`
InternalNotes any `json:"internal_notes,omitempty"`
StructuredClauses []map[string]any `json:"structured_clauses,omitempty"`
EfileMetadata any `json:"efile_metadata,omitempty"`
AttachesTo any `json:"attaches_to,omitempty"`
AttachmentKind any `json:"attachment_kind,omitempty"`
RelatedDocuments []map[string]any `json:"related_documents,omitempty"`
CoverPageFields any `json:"cover_page_fields,omitempty"`
EquityPromise any `json:"equity_promise,omitempty"`
StandardTermsTemplateId any `json:"standard_terms_template_id,omitempty"`
TemplateId any `json:"template_id,omitempty"`
TemplateVersion any `json:"template_version,omitempty"`
CurrentVersionId any `json:"current_version_id,omitempty"`
EntitySnapshot map[string]any `json:"entity_snapshot,omitempty"`
Payload map[string]any `json:"payload,omitempty"`
PdfUrl any `json:"pdf_url,omitempty"`
Sha256 string `json:"sha256"`
Proof any `json:"proof,omitempty"`
Version int64 `json:"version"`
ParentDocumentId any `json:"parent_document_id,omitempty"`
Signatures []map[string]any `json:"signatures,omitempty"`
EnvelopeId any `json:"envelope_id,omitempty"`
Sensitivity string `json:"sensitivity,omitempty"`
Disclaimer Disclaimer `json:"disclaimer,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}DocumentAccessGrant
Typed-ID prefix dag_. Permissioned access to a document for a specific grantee (typically scoped to
// DocumentAccessGrant — Permissioned access to a document for a specific grantee (typically scoped to
type DocumentAccessGrant struct {
Id string `json:"id"`
Object string `json:"object"`
DocumentId string `json:"document_id"`
DataRoomId any `json:"data_room_id,omitempty"`
GranteeEmail string `json:"grantee_email"`
GranteeStakeholderId any `json:"grantee_stakeholder_id,omitempty"`
Permissions []string `json:"permissions"`
Status string `json:"status"`
ExpiresAt any `json:"expires_at,omitempty"`
LastAccessedAt any `json:"last_accessed_at,omitempty"`
AccessCount int64 `json:"access_count,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}DocumentVersion
Typed-ID prefix docv_. Immutable point-in-time snapshot of a Document. Each regenerate, sign,
// DocumentVersion — Immutable point-in-time snapshot of a `Document`. Each regenerate, sign,
type DocumentVersion struct {
Id string `json:"id"`
Object string `json:"object"`
DocumentId string `json:"document_id"`
Version int64 `json:"version"`
Status string `json:"status"`
Sha256 string `json:"sha256"`
Payload map[string]any `json:"payload,omitempty"`
PdfUrl any `json:"pdf_url,omitempty"`
Proof any `json:"proof,omitempty"`
ActorId any `json:"actor_id,omitempty"`
ChangeKind string `json:"change_kind,omitempty"`
PreviousVersionId any `json:"previous_version_id,omitempty"`
Created int64 `json:"created"`
Livemode bool `json:"livemode,omitempty"`
}EarnOut
Typed-ID prefix eo_. Contingent post-closing consideration tied to performance metrics. Common in
// EarnOut — Contingent post-closing consideration tied to performance metrics. Common in
type EarnOut struct {
Id string `json:"id"`
Object string `json:"object"`
CorporateTransactionId string `json:"corporate_transaction_id"`
Metric string `json:"metric"`
Target MonetaryAmount `json:"target"`
MaxPayout MonetaryAmount `json:"max_payout,omitempty"`
Periods []map[string]any `json:"periods,omitempty"`
TrueUpMechanic string `json:"true_up_mechanic,omitempty"`
Formula any `json:"formula,omitempty"`
CurrentStatus string `json:"current_status,omitempty"`
PayoutSchedule []map[string]any `json:"payout_schedule,omitempty"`
Status string `json:"status"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Entity
Typed-ID prefix ent_. A legal entity — the central object of the Matter API. Entities flow through the
// Entity — A legal entity — the central object of the Matter API. Entities flow through the
type Entity struct {
Id string `json:"id"`
Object string `json:"object"`
Status string `json:"status"`
Type string `json:"type"`
Jurisdiction Jurisdiction `json:"jurisdiction"`
LegalName string `json:"legal_name"`
Aliases []string `json:"aliases,omitempty"`
FormedAt any `json:"formed_at,omitempty"`
DissolvedAt any `json:"dissolved_at,omitempty"`
AcquiredAt any `json:"acquired_at,omitempty"`
MergedAt any `json:"merged_at,omitempty"`
SoldAt any `json:"sold_at,omitempty"`
WorkspaceId any `json:"workspace_id,omitempty"`
CorporateTransactionId any `json:"corporate_transaction_id,omitempty"`
PrincipalAddress Address `json:"principal_address,omitempty"`
MailingAddress Address `json:"mailing_address,omitempty"`
RegisteredAgentId string `json:"registered_agent_id,omitempty"`
IncorporatorStakeholderId string `json:"incorporator_stakeholder_id,omitempty"`
TaxProfileId string `json:"tax_profile_id,omitempty"`
StakeholderIds []string `json:"stakeholder_ids,omitempty"`
CapTableId string `json:"cap_table_id,omitempty"`
EquityPlanIds []string `json:"equity_plan_ids,omitempty"`
Qualifications []Qualification `json:"qualifications,omitempty"`
Compliance map[string]any `json:"compliance,omitempty"`
IntentId any `json:"intent_id,omitempty"`
IncorporatorReceiptId any `json:"incorporator_receipt_id,omitempty"`
PortfolioId any `json:"portfolio_id,omitempty"`
GoverningDocuments map[string]any `json:"governing_documents,omitempty"`
FormationPacketStatus string `json:"formation_packet_status,omitempty"`
ExternalStatus any `json:"external_status,omitempty"`
ActiveBrowserAgentRunId any `json:"active_browser_agent_run_id,omitempty"`
BrowserAgentRun any `json:"browser_agent_run,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}EntityTemplateOverride
Typed-ID prefix eto_. Entity-scoped overlay. Same shape as OrgTemplateCustomization,
// EntityTemplateOverride — Entity-scoped overlay. Same shape as `OrgTemplateCustomization`,
type EntityTemplateOverride struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
OrgId string `json:"org_id"`
TemplateId string `json:"template_id"`
Mode string `json:"mode"`
CompatibleRevisionsMin string `json:"compatible_revisions_min"`
CompatibleRevisionsMax string `json:"compatible_revisions_max"`
ClauseOverlays []map[string]any `json:"clause_overlays"`
FieldDefaultOverlays []map[string]any `json:"field_default_overlays"`
SignerRoleOverrides []map[string]any `json:"signer_role_overrides"`
Attachments []map[string]any `json:"attachments"`
AuthoredAgainstRevisionId any `json:"authored_against_revision_id,omitempty"`
DeletedAt any `json:"deleted_at,omitempty"`
Created string `json:"created,omitempty"`
Updated string `json:"updated,omitempty"`
}EquityPlan
Typed-ID prefix plan_. Authorized option pool or stock plan. Grants are drawn from a plan.
// EquityPlan — Authorized option pool or stock plan. Grants are drawn from a plan.
type EquityPlan struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Name string `json:"name"`
Type string `json:"type"`
AuthorizedShares int64 `json:"authorized_shares"`
ReservedShares int64 `json:"reserved_shares,omitempty"`
GrantedShares int64 `json:"granted_shares"`
AvailableShares int64 `json:"available_shares,omitempty"`
EffectiveDate string `json:"effective_date"`
BoardResolutionId string `json:"board_resolution_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Escrow
Typed-ID prefix esc_. Holdback of consideration at closing for indemnity, working-capital, or special-
// Escrow — Holdback of consideration at closing for indemnity, working-capital, or special-
type Escrow struct {
Id string `json:"id"`
Object string `json:"object"`
CorporateTransactionId string `json:"corporate_transaction_id"`
Amount MonetaryAmount `json:"amount"`
PercentOfConsiderationBasisPoints int64 `json:"percent_of_consideration_basis_points,omitempty"`
PeriodMonths int64 `json:"period_months"`
Agent string `json:"agent,omitempty"`
Purpose []string `json:"purpose,omitempty"`
Status string `json:"status"`
ReleaseSchedule []map[string]any `json:"release_schedule,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Event
Typed-ID prefix evt_. Webhook event. Every state change emits exactly one. Strict per-subject ordering
// Event — Webhook event. Every state change emits exactly one. Strict per-subject ordering
type Event struct {
Id string `json:"id"`
Object string `json:"object"`
Type string `json:"type"`
ApiVersion string `json:"api_version"`
Created int64 `json:"created"`
Data map[string]any `json:"data"`
Sequence int64 `json:"sequence"`
Livemode bool `json:"livemode"`
PendingWebhooks int64 `json:"pending_webhooks,omitempty"`
Request map[string]any `json:"request,omitempty"`
AuthorizedBy AuthorizedBy `json:"authorized_by,omitempty"`
}EvidenceBundle
Typed-ID prefix evb_. Litigation-grade self-contained ZIP artifact produced by
// EvidenceBundle — Litigation-grade self-contained ZIP artifact produced by
type EvidenceBundle struct {
Object string `json:"object"`
Id string `json:"id"`
DocumentId string `json:"document_id"`
ArchiveUri string `json:"archive_uri"`
ContentSha256 string `json:"content_sha256"`
Manifest map[string]any `json:"manifest"`
ChainSignature string `json:"chain_signature"`
Created string `json:"created"`
}File
Typed-ID prefix file_. A byte-level artifact — stakeholder KYC document, cap-table CSV import,
// File — A byte-level artifact — stakeholder KYC document, cap-table CSV import,
type File struct {
Id string `json:"id"`
Object string `json:"object"`
Purpose string `json:"purpose"`
Size int64 `json:"size"`
Type string `json:"type"`
Filename any `json:"filename,omitempty"`
Sha256 string `json:"sha256"`
LinkedResources []map[string]any `json:"linked_resources,omitempty"`
ExpiresAt any `json:"expires_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Livemode bool `json:"livemode"`
}FileLink
Typed-ID prefix link_. A time-limited signed URL to a File's bytes. Reissue after expiry.
// FileLink — A time-limited signed URL to a `File`'s bytes. Reissue after expiry.
type FileLink struct {
Id string `json:"id"`
Object string `json:"object"`
FileId string `json:"file_id"`
Url string `json:"url"`
ExpiresAt int64 `json:"expires_at"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Livemode bool `json:"livemode"`
}Filing
Typed-ID prefix flg_. A state or federal filing. Polymorphic — payload is discriminated by type.
// Filing — A state or federal filing. Polymorphic — `payload` is discriminated by `type`.
type Filing struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Type string `json:"type"`
Jurisdiction Jurisdiction `json:"jurisdiction"`
Status string `json:"status"`
Payload any `json:"payload,omitempty"`
SubmittedAt any `json:"submitted_at,omitempty"`
AcceptedAt any `json:"accepted_at,omitempty"`
RejectedReason any `json:"rejected_reason,omitempty"`
StateConfirmationNumber any `json:"state_confirmation_number,omitempty"`
DocumentIds []string `json:"document_ids,omitempty"`
AuthorizingResolutionId any `json:"authorizing_resolution_id,omitempty"`
AuthorizingCorporateTransactionId any `json:"authorizing_corporate_transaction_id,omitempty"`
PrerequisiteFilings []string `json:"prerequisite_filings,omitempty"`
DependsOn []string `json:"depends_on,omitempty"`
FinalReturn bool `json:"final_return,omitempty"`
PostDissolutionFiling bool `json:"post_dissolution_filing,omitempty"`
Fees map[string]any `json:"fees,omitempty"`
CancellationWindowEndsAt any `json:"cancellation_window_ends_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}FormationSession
Typed-ID prefix fss_. Tracks the multi-step formation flow for a single entity
// FormationSession — Tracks the multi-step formation flow for a single entity
type FormationSession struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
IntentId any `json:"intent_id,omitempty"`
Mode string `json:"mode"`
Status string `json:"status"`
CurrentStep string `json:"current_step"`
Progress any `json:"progress,omitempty"`
StartedAt string `json:"started_at"`
CompletedAt any `json:"completed_at,omitempty"`
Version int64 `json:"version"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}Grant
Typed-ID prefix grt_. Option, RSU, or restricted-stock grant. The kind enum covers both
// Grant — Option, RSU, or restricted-stock grant. The `kind` enum covers both
type Grant struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
StakeholderId string `json:"stakeholder_id"`
EquityPlanId any `json:"equity_plan_id,omitempty"`
Kind string `json:"kind"`
Quantity int64 `json:"quantity"`
StrikePrice MonetaryAmount `json:"strike_price,omitempty"`
ValuationId any `json:"valuation_id,omitempty"`
VestingSchedule map[string]any `json:"vesting_schedule,omitempty"`
AccelerationCondition any `json:"acceleration_condition,omitempty"`
AccelerationEvents []map[string]any `json:"acceleration_events,omitempty"`
Clawback any `json:"clawback,omitempty"`
Election_83b any `json:"election_83b,omitempty"`
FounderRestrictedStockTerms any `json:"founder_restricted_stock_terms,omitempty"`
AmendedFromGrantId any `json:"amended_from_grant_id,omitempty"`
AmendmentReason any `json:"amendment_reason,omitempty"`
GrantDate string `json:"grant_date"`
ExpirationDate any `json:"expiration_date,omitempty"`
ExercisedQuantity int64 `json:"exercised_quantity,omitempty"`
DocumentId any `json:"document_id,omitempty"`
QsbsEligibilityDate any `json:"qsbs_eligibility_date,omitempty"`
Pre_409aGrantPauseUntil any `json:"pre_409a_grant_pause_until,omitempty"`
Status string `json:"status,omitempty"`
ActivatedAt any `json:"activated_at,omitempty"`
Documents map[string]any `json:"documents,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}IncorporatorReceipt
Typed-ID prefix ir_. Immutable cryptographic proof issued at the end of a successful incorporator
// IncorporatorReceipt — Immutable cryptographic proof issued at the end of a successful incorporator
type IncorporatorReceipt struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
GenesisCeremonyId string `json:"genesis_ceremony_id"`
AuditChainRootHash string `json:"audit_chain_root_hash"`
RekorInclusionProof any `json:"rekor_inclusion_proof,omitempty"`
WitnessSignatures any `json:"witness_signatures,omitempty"`
IssuedAt string `json:"issued_at"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}IndemnificationAgreement
Typed-ID prefix ind_. Director-and-officer indemnification covenant between an entity and an
// IndemnificationAgreement — Director-and-officer indemnification covenant between an entity and an
type IndemnificationAgreement struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
IndemniteeStakeholderId string `json:"indemnitee_stakeholder_id"`
Role string `json:"role"`
AuthorizingResolutionId any `json:"authorizing_resolution_id,omitempty"`
DocumentId any `json:"document_id,omitempty"`
EnvelopeId any `json:"envelope_id,omitempty"`
EffectiveDate any `json:"effective_date,omitempty"`
TerminationDate any `json:"termination_date,omitempty"`
Coverage map[string]any `json:"coverage,omitempty"`
Status string `json:"status"`
SignedAt any `json:"signed_at,omitempty"`
TerminatedAt any `json:"terminated_at,omitempty"`
TerminationReason any `json:"termination_reason,omitempty"`
CarveOuts []map[string]any `json:"carve_outs,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}IndemnityClaim
Typed-ID prefix idc_. A claim by acquirer (or rarely seller) under the definitive agreement's
// IndemnityClaim — A claim by acquirer (or rarely seller) under the definitive agreement's
type IndemnityClaim struct {
Id string `json:"id"`
Object string `json:"object"`
CorporateTransactionId string `json:"corporate_transaction_id"`
Claimant string `json:"claimant"`
Amount MonetaryAmount `json:"amount"`
Basis string `json:"basis"`
FundamentalCarveout bool `json:"fundamental_carveout,omitempty"`
ResponseDeadline any `json:"response_deadline,omitempty"`
Status string `json:"status"`
Kind any `json:"kind,omitempty"`
ResolutionPath any `json:"resolution_path,omitempty"`
ReleaseDocumentId any `json:"release_document_id,omitempty"`
EscrowId any `json:"escrow_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Intent
Typed-ID prefix int_. Customer-facing label: Incorporation plan (or, more generally, a
// Intent — Customer-facing label: **Incorporation plan** (or, more generally, a
type Intent struct {
Id string `json:"id"`
Object string `json:"object"`
Goal string `json:"goal"`
Parameters any `json:"parameters"`
Status string `json:"status"`
ExecutionPlan ExecutionPlan `json:"execution_plan,omitempty"`
EntityId any `json:"entity_id,omitempty"`
CostEstimate MonetaryAmount `json:"cost_estimate,omitempty"`
CompletedAt any `json:"completed_at,omitempty"`
ResolvedRecommendations []Recommendation `json:"resolved_recommendations,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}Invoice
Typed-ID prefix inv_. An invoice issued to the account — entity-license subscription invoices and
// Invoice — An invoice issued to the account — entity-license subscription invoices and
type Invoice struct {
Id string `json:"id"`
Object string `json:"object"`
AccountId string `json:"account_id"`
Number any `json:"number,omitempty"`
Status string `json:"status"`
Total MonetaryAmount `json:"total"`
Lines []map[string]any `json:"lines,omitempty"`
HostedInvoiceUrl any `json:"hosted_invoice_url,omitempty"`
PdfUrl any `json:"pdf_url,omitempty"`
PeriodStart any `json:"period_start,omitempty"`
PeriodEnd any `json:"period_end,omitempty"`
PaidAt any `json:"paid_at,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}JurisdictionVariant
Typed-ID prefix jvr_. Per-jurisdiction overrides applied between the platform body
// JurisdictionVariant — Per-jurisdiction overrides applied between the platform body
type JurisdictionVariant struct {
Object string `json:"object"`
Id string `json:"id"`
TemplateRevisionId string `json:"template_revision_id"`
Jurisdiction string `json:"jurisdiction"`
ClauseOverrides map[string]any `json:"clause_overrides,omitempty"`
SignerOverrides map[string]any `json:"signer_overrides,omitempty"`
LegalBasisOverrides map[string]any `json:"legal_basis_overrides,omitempty"`
}LedgerEntry
Typed-ID prefix lgr_. One append-only money movement on the account's prepaid ledger. Entries are
// LedgerEntry — One append-only money movement on the account's prepaid ledger. Entries are
type LedgerEntry struct {
Id string `json:"id"`
Object string `json:"object"`
AccountId string `json:"account_id"`
Kind string `json:"kind"`
Amount MonetaryAmount `json:"amount"`
BalanceAfter MonetaryAmount `json:"balance_after"`
SourceType string `json:"source_type"`
SourceId string `json:"source_id"`
RequestId any `json:"request_id,omitempty"`
Created int64 `json:"created"`
Livemode bool `json:"livemode"`
}LegalOpinion
Typed-ID prefix lgo_. Closing-condition legal opinion delivered by counsel. Standard on priced
// LegalOpinion — Closing-condition legal opinion delivered by counsel. Standard on priced
type LegalOpinion struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Parent map[string]any `json:"parent"`
IssuingFirm string `json:"issuing_firm"`
IssuingAttorney any `json:"issuing_attorney,omitempty"`
OpinionsCovered []string `json:"opinions_covered,omitempty"`
DocumentId any `json:"document_id,omitempty"`
DeliveredAt any `json:"delivered_at,omitempty"`
Status string `json:"status"`
Qualifications []string `json:"qualifications,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}MailItem
Typed-ID prefix mail_. One piece of inbound correspondence received by the registered agent on behalf of an
// MailItem — One piece of inbound correspondence received by the registered agent on behalf of an
type MailItem struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Source string `json:"source"`
Category string `json:"category"`
Status string `json:"status"`
Sender any `json:"sender,omitempty"`
ReturnAddress any `json:"return_address,omitempty"`
Subject any `json:"subject,omitempty"`
OcrText any `json:"ocr_text,omitempty"`
Extracted any `json:"extracted,omitempty"`
ResponseDeadline any `json:"response_deadline,omitempty"`
ReceivedAt int64 `json:"received_at"`
ScannedAt any `json:"scanned_at,omitempty"`
ScanDocumentId any `json:"scan_document_id,omitempty"`
ResponseDocumentId any `json:"response_document_id,omitempty"`
RelatedFilingId any `json:"related_filing_id,omitempty"`
EscalationAuthorizationId any `json:"escalation_authorization_id,omitempty"`
Forwarding any `json:"forwarding,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}Officer
Typed-ID prefix off_. Canonical officer record. Created by changeOfficer (action: appoint)
// Officer — Canonical officer record. Created by `changeOfficer` (action: appoint)
type Officer struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
StakeholderId string `json:"stakeholder_id"`
Title string `json:"title"`
Status string `json:"status"`
EffectiveDate string `json:"effective_date"`
AppointedViaResolutionId string `json:"appointed_via_resolution_id,omitempty"`
RemovedViaResolutionId string `json:"removed_via_resolution_id,omitempty"`
RemovedAt string `json:"removed_at,omitempty"`
Livemode bool `json:"livemode,omitempty"`
}OrgTemplateCustomization
Typed-ID prefix otc_. Org-scoped overlay — applies to every entity in the org. Per
// OrgTemplateCustomization — Org-scoped overlay — applies to every entity in the org. Per
type OrgTemplateCustomization struct {
Object string `json:"object"`
Id string `json:"id"`
OrgId string `json:"org_id"`
TemplateId string `json:"template_id"`
Mode string `json:"mode"`
CompatibleRevisionsMin string `json:"compatible_revisions_min"`
CompatibleRevisionsMax string `json:"compatible_revisions_max"`
ClauseOverlays []map[string]any `json:"clause_overlays"`
FieldDefaultOverlays []map[string]any `json:"field_default_overlays"`
SignerRoleOverrides []map[string]any `json:"signer_role_overrides"`
Attachments []map[string]any `json:"attachments"`
AuthoredAgainstRevisionId any `json:"authored_against_revision_id,omitempty"`
DeletedAt any `json:"deleted_at,omitempty"`
Created string `json:"created,omitempty"`
Updated string `json:"updated,omitempty"`
CreatedByTokenId any `json:"created_by_token_id,omitempty"`
UpdatedByTokenId any `json:"updated_by_token_id,omitempty"`
}ParachuteAnalysis
Typed-ID prefix pa_. Structured §280G analysis attached to a CorporateTransaction. Identifies
// ParachuteAnalysis — Structured §280G analysis attached to a `CorporateTransaction`. Identifies
type ParachuteAnalysis struct {
Id string `json:"id"`
Object string `json:"object"`
CorporateTransactionId string `json:"corporate_transaction_id"`
AnalysisKind string `json:"analysis_kind"`
Status string `json:"status"`
DisqualifiedIndividuals []map[string]any `json:"disqualified_individuals"`
ParachutePaymentsBreakdown []map[string]any `json:"parachute_payments_breakdown"`
DisclosureDocumentId any `json:"disclosure_document_id,omitempty"`
CleansingVoteResolutionId any `json:"cleansing_vote_resolution_id,omitempty"`
TaxCounselFirm any `json:"tax_counsel_firm,omitempty"`
OverrideAssumptions any `json:"override_assumptions,omitempty"`
ComputedAt any `json:"computed_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}Portfolio
Typed-ID prefix pf_. Venture-studio grouping. First-class resource — safer than implicit header-based
// Portfolio — Venture-studio grouping. First-class resource — safer than implicit header-based
type Portfolio struct {
Id string `json:"id"`
Object string `json:"object"`
Mode string `json:"mode"`
Name string `json:"name"`
SharedRegisteredAgentId any `json:"shared_registered_agent_id"`
SharedComplianceCalendar bool `json:"shared_compliance_calendar"`
EntityIds []string `json:"entity_ids"`
Version int64 `json:"version"`
Metadata Metadata `json:"metadata"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}Qualification
Typed-ID prefix qal_. A foreign qualification — registration of an entity in a non-home jurisdiction.
// Qualification — A foreign qualification — registration of an entity in a non-home jurisdiction.
type Qualification struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Jurisdiction Jurisdiction `json:"jurisdiction"`
Status string `json:"status"`
QualifiedAt any `json:"qualified_at,omitempty"`
RegisteredAgentId any `json:"registered_agent_id,omitempty"`
ComplianceTrack map[string]any `json:"compliance_track,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Questionnaire
Typed-ID prefix qst_. Structured questionnaire collected from a stakeholder. Used as a closing
// Questionnaire — Structured questionnaire collected from a stakeholder. Used as a closing
type Questionnaire struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Kind string `json:"kind"`
SubjectStakeholderId string `json:"subject_stakeholder_id"`
RelatedRoundId any `json:"related_round_id,omitempty"`
RelatedCorporateTransactionId any `json:"related_corporate_transaction_id,omitempty"`
Responses any `json:"responses,omitempty"`
DocumentId any `json:"document_id,omitempty"`
EnvelopeId any `json:"envelope_id,omitempty"`
SignedAt any `json:"signed_at,omitempty"`
Status string `json:"status"`
Verification any `json:"verification,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}RegisteredAgent
Typed-ID prefix ra_. Registered agent of record in a jurisdiction. Required by every state. Swapping a
// RegisteredAgent — Registered agent of record in a jurisdiction. Required by every state. Swapping a
type RegisteredAgent struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Jurisdiction Jurisdiction `json:"jurisdiction"`
Provider string `json:"provider"`
ExternalProviderName any `json:"external_provider_name,omitempty"`
Address Address `json:"address"`
EffectiveDate string `json:"effective_date"`
TerminatedAt any `json:"terminated_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}ReportRun
Typed-ID prefix run_. An async report run. Starts in pending, advances through running to
// ReportRun — An async report run. Starts in `pending`, advances through `running` to
type ReportRun struct {
Id string `json:"id"`
Object string `json:"object"`
ReportType string `json:"report_type"`
Status string `json:"status"`
Parameters map[string]any `json:"parameters"`
Format string `json:"format,omitempty"`
Result any `json:"result,omitempty"`
Error any `json:"error,omitempty"`
StartedAt any `json:"started_at,omitempty"`
FinishedAt any `json:"finished_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Request
Typed-ID prefix req_. Record of a single API request. Retained 7 days by default (extensible per plan).
// Request — Record of a single API request. Retained 7 days by default (extensible per plan).
type Request struct {
Id string `json:"id"`
Object string `json:"object"`
Method string `json:"method"`
Path string `json:"path"`
Status int64 `json:"status"`
IdempotencyKey any `json:"idempotency_key,omitempty"`
Actor map[string]any `json:"actor,omitempty"`
AuthorizedBy AuthorizedBy `json:"authorized_by,omitempty"`
RequestBody any `json:"request_body,omitempty"`
ResponseBody any `json:"response_body,omitempty"`
OccurredAt int64 `json:"occurred_at"`
Livemode bool `json:"livemode"`
}Resolution
Typed-ID prefix res_. Board meeting or written consent authorizing entity actions.
// Resolution — Board meeting or written consent authorizing entity actions.
type Resolution struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Kind string `json:"kind"`
Subject string `json:"subject"`
ResolvedAt any `json:"resolved_at,omitempty"`
Variant any `json:"variant,omitempty"`
Signatories []map[string]any `json:"signatories,omitempty"`
OfficerChanges []map[string]any `json:"officer_changes,omitempty"`
DocumentId any `json:"document_id,omitempty"`
AuthorizesFilings []string `json:"authorizes_filings,omitempty"`
AuthorizesAgreements []string `json:"authorizes_agreements,omitempty"`
AuthorizesGrants []string `json:"authorizes_grants,omitempty"`
AuthorizesShareReservations []string `json:"authorizes_share_reservations,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Round
Typed-ID prefix rnd_. Priced-round envelope. Owns the multi-week negotiation between term-sheet entry
// Round — Priced-round envelope. Owns the multi-week negotiation between term-sheet entry
type Round struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Name string `json:"name"`
Kind string `json:"kind"`
Stage string `json:"stage"`
PreMoney MonetaryAmount `json:"pre_money,omitempty"`
Investment MonetaryAmount `json:"investment,omitempty"`
PostMoney MonetaryAmount `json:"post_money,omitempty"`
PricePerShare MonetaryAmount `json:"price_per_share,omitempty"`
OptionPoolRefreshBasisPoints int64 `json:"option_pool_refresh_basis_points,omitempty"`
PreMoneyPoolShuffle bool `json:"pre_money_pool_shuffle,omitempty"`
ShareClassId any `json:"share_class_id,omitempty"`
ShareClass map[string]any `json:"share_class,omitempty"`
BoardReconstitution map[string]any `json:"board_reconstitution,omitempty"`
Investors []map[string]any `json:"investors,omitempty"`
MfnHolders []string `json:"mfn_holders,omitempty"`
ClosingConditions []map[string]any `json:"closing_conditions,omitempty"`
GoverningDocuments map[string]any `json:"governing_documents,omitempty"`
PostCloseGovernance map[string]any `json:"post_close_governance,omitempty"`
QualifiedFinancingForSafes bool `json:"qualified_financing_for_safes,omitempty"`
AuthorizingResolutionId any `json:"authorizing_resolution_id,omitempty"`
DocumentIds []string `json:"document_ids,omitempty"`
SigningDate any `json:"signing_date,omitempty"`
ClosingDate any `json:"closing_date,omitempty"`
PartialCloses []map[string]any `json:"partial_closes,omitempty"`
PreCloseSnapshotId any `json:"pre_close_snapshot_id,omitempty"`
PostCloseSnapshotId any `json:"post_close_snapshot_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}ShareClass
Typed-ID prefix cls_. A class of shares authorized for an entity (Common, Series Seed, Series A, etc.).
// ShareClass — A class of shares authorized for an entity (Common, Series Seed, Series A, etc.).
type ShareClass struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Name string `json:"name"`
Kind string `json:"kind,omitempty"`
Series any `json:"series,omitempty"`
Authorized int64 `json:"authorized"`
Issued int64 `json:"issued"`
ParValue MonetaryAmount `json:"par_value"`
LiquidationPreference any `json:"liquidation_preference,omitempty"`
ConversionRights map[string]any `json:"conversion_rights,omitempty"`
VotingRights map[string]any `json:"voting_rights,omitempty"`
CertificateOfDesignationsDocumentId any `json:"certificate_of_designations_document_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}ShareLedgerEntry
Typed-ID prefix led_. One entry per equity event. Covers traditional share mutations
// ShareLedgerEntry — One entry per equity event. Covers traditional share mutations
type ShareLedgerEntry struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Kind string `json:"kind"`
ShareClassId any `json:"share_class_id,omitempty"`
FromStakeholderId any `json:"from_stakeholder_id,omitempty"`
ToStakeholderId any `json:"to_stakeholder_id,omitempty"`
Quantity any `json:"quantity,omitempty"`
PricePerShare MonetaryAmount `json:"price_per_share,omitempty"`
Consideration string `json:"consideration,omitempty"`
CertificateNumber any `json:"certificate_number,omitempty"`
TransactionDate string `json:"transaction_date"`
PrincipalAmount any `json:"principal_amount,omitempty"`
SafeType any `json:"safe_type,omitempty"`
SafeMoneyPosition any `json:"safe_money_position,omitempty"`
SafeVariant any `json:"safe_variant,omitempty"`
SafeJurisdiction any `json:"safe_jurisdiction,omitempty"`
ProRataRights any `json:"pro_rata_rights,omitempty"`
QualifyingFinancingThresholdCents any `json:"qualifying_financing_threshold_cents,omitempty"`
Mfn any `json:"mfn,omitempty"`
MfnWindowMonths any `json:"mfn_window_months,omitempty"`
MfnAmendments []map[string]any `json:"mfn_amendments,omitempty"`
InterestRate any `json:"interest_rate,omitempty"`
DiscountRate any `json:"discount_rate,omitempty"`
ValuationCap any `json:"valuation_cap,omitempty"`
MaturityDate any `json:"maturity_date,omitempty"`
ReferencesEntryId any `json:"references_entry_id,omitempty"`
DocumentIds []string `json:"document_ids,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}SideLetter
Typed-ID prefix sl_. Investor side letter granting individual rights beyond the standard
// SideLetter — Investor side letter granting individual rights beyond the standard
type SideLetter struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Parent map[string]any `json:"parent"`
InvestorStakeholderId string `json:"investor_stakeholder_id"`
Clauses []map[string]any `json:"clauses"`
DocumentId any `json:"document_id,omitempty"`
EnvelopeId any `json:"envelope_id,omitempty"`
SignedAt any `json:"signed_at,omitempty"`
Status string `json:"status"`
TerminatedAt any `json:"terminated_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}SigningEnvelope
Typed-ID prefix env_. Coordinates multi-party signing of one or more Documents. Per-document
// SigningEnvelope — Coordinates multi-party signing of one or more `Document`s. Per-document
type SigningEnvelope struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Subject string `json:"subject,omitempty"`
DocumentIds []string `json:"document_ids"`
Signers []EnvelopeSigner `json:"signers"`
Routing string `json:"routing"`
Status string `json:"status"`
SentAt any `json:"sent_at,omitempty"`
CompletedAt any `json:"completed_at,omitempty"`
ExpiresAt any `json:"expires_at,omitempty"`
LastReminderAt any `json:"last_reminder_at,omitempty"`
ReminderPolicy map[string]any `json:"reminder_policy,omitempty"`
Message string `json:"message,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}SigningSession
Typed-ID prefix sig_. Short-lived bearer for human-signature-over-API (Rail 1, Shape 2). Issued via
// SigningSession — Short-lived bearer for human-signature-over-API (Rail 1, Shape 2). Issued via
type SigningSession struct {
Id string `json:"id"`
Object string `json:"object"`
Target map[string]any `json:"target"`
StakeholderId string `json:"stakeholder_id"`
HumanClerkUserId string `json:"human_clerk_user_id"`
CreatedAt int64 `json:"created_at"`
ExpiresAt int64 `json:"expires_at"`
Status string `json:"status"`
SignatureToken any `json:"signature_token,omitempty"`
DisclosurePacketHash string `json:"disclosure_packet_hash,omitempty"`
Livemode bool `json:"livemode"`
}Stakeholder
Typed-ID prefix stk_. A person (or another entity) associated with a Matter entity. Roles are an array —
// Stakeholder — A person (or another entity) associated with a Matter entity. Roles are an array —
type Stakeholder struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Kind string `json:"kind"`
Name string `json:"name"`
Contact map[string]any `json:"contact,omitempty"`
TaxId string `json:"tax_id,omitempty"`
Residency string `json:"residency,omitempty"`
DateOfBirth any `json:"date_of_birth,omitempty"`
ResidentialAddress any `json:"residential_address,omitempty"`
Identification any `json:"identification,omitempty"`
BoiEligibility string `json:"boi_eligibility,omitempty"`
BoiMissingFields []string `json:"boi_missing_fields,omitempty"`
BeneficialOwnerPercentage any `json:"beneficial_owner_percentage,omitempty"`
VotingPercentage any `json:"voting_percentage,omitempty"`
CapTablePercentage any `json:"cap_table_percentage,omitempty"`
BoiFilingStatus string `json:"boi_filing_status,omitempty"`
ExperienceLevel string `json:"experience_level,omitempty"`
AccreditedInvestorStatus string `json:"accredited_investor_status,omitempty"`
FivePercentHolder bool `json:"five_percent_holder,omitempty"`
IpAssignmentScope string `json:"ip_assignment_scope,omitempty"`
ConsiderationForInitialShares any `json:"consideration_for_initial_shares,omitempty"`
SignedArtifacts []map[string]any `json:"signed_artifacts,omitempty"`
Status string `json:"status,omitempty"`
Roles []map[string]any `json:"roles"`
ResidenceState any `json:"residence_state,omitempty"`
MaritalStatus string `json:"marital_status,omitempty"`
SpouseId any `json:"spouse_id,omitempty"`
SpouseName any `json:"spouse_name,omitempty"`
SpouseTaxIdToken any `json:"spouse_tax_id_token,omitempty"`
SeparatedAt any `json:"separated_at,omitempty"`
SeparationKind any `json:"separation_kind,omitempty"`
SeparationReason any `json:"separation_reason,omitempty"`
TransitionedToAcquirerId any `json:"transitioned_to_acquirer_id,omitempty"`
CommunityPropertyStateAtGrant any `json:"community_property_state_at_grant,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}StakeholderPortalSession
Typed-ID prefix sps_. Hosted URL where a stakeholder accepts grants, signs 83(b) elections, downloads
// StakeholderPortalSession — Hosted URL where a stakeholder accepts grants, signs 83(b) elections, downloads
type StakeholderPortalSession struct {
Id string `json:"id"`
Object string `json:"object"`
StakeholderId string `json:"stakeholder_id"`
Url string `json:"url"`
ReturnUrl string `json:"return_url"`
Scope []string `json:"scope"`
Metadata Metadata `json:"metadata,omitempty"`
ExpiresAt int64 `json:"expires_at"`
Created int64 `json:"created"`
Livemode bool `json:"livemode"`
}StateRegistration
Typed-ID prefix reg_. State-level registration filed via the registered-agent partner.
// StateRegistration — State-level registration filed via the registered-agent partner.
type StateRegistration struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
RegistrationKind string `json:"registration_kind"`
Agency any `json:"agency,omitempty"`
AgencyAccountKind any `json:"agency_account_kind,omitempty"`
Jurisdiction map[string]any `json:"jurisdiction"`
Status string `json:"status"`
EffectiveDate string `json:"effective_date"`
ConfirmedAt any `json:"confirmed_at,omitempty"`
ClosedAt any `json:"closed_at,omitempty"`
ClosureStatus any `json:"closure_status,omitempty"`
StateAccountNumber any `json:"state_account_number,omitempty"`
TradeName any `json:"trade_name,omitempty"`
Trigger any `json:"trigger,omitempty"`
RegisteredAgentPartnerId any `json:"registered_agent_partner_id,omitempty"`
Obligations []map[string]any `json:"obligations,omitempty"`
}SubAgentSession
Typed-ID prefix sas_. Async wrapper for a government or partner web interface that doesn't
// SubAgentSession — Async wrapper for a government or partner web interface that doesn't
type SubAgentSession struct {
Id string `json:"id"`
Object string `json:"object"`
Status string `json:"status"`
TargetResource map[string]any `json:"target_resource"`
AgentKind string `json:"agent_kind"`
TargetUrl string `json:"target_url,omitempty"`
CreatedAt string `json:"created_at"`
StartedAt string `json:"started_at,omitempty"`
CompletedAt string `json:"completed_at,omitempty"`
Outcome map[string]any `json:"outcome,omitempty"`
ActionsTaken []map[string]any `json:"actions_taken,omitempty"`
Livemode bool `json:"livemode,omitempty"`
}TaxElection
Typed-ID prefix txe_. A tax election filed for an entity (S-Corp, §83(b), check-the-box, late-election
// TaxElection — A tax election filed for an entity (S-Corp, §83(b), check-the-box, late-election
type TaxElection struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Kind string `json:"kind"`
Status string `json:"status"`
EffectiveDate string `json:"effective_date"`
FilingId any `json:"filing_id,omitempty"`
DocumentId any `json:"document_id,omitempty"`
GrantId any `json:"grant_id,omitempty"`
ShareLotId any `json:"share_lot_id,omitempty"`
Qsbs any `json:"qsbs,omitempty"`
TargetClassification any `json:"target_classification,omitempty"`
ShareholderConsents []string `json:"shareholder_consents,omitempty"`
OriginalElectionKind any `json:"original_election_kind,omitempty"`
ReasonForFailure any `json:"reason_for_failure,omitempty"`
RejectionReason any `json:"rejection_reason,omitempty"`
AcceptedAt any `json:"accepted_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}TaxProfile
Typed-ID prefix tax_. Tax identifiers and elections for an entity. Election state mirrors filings
// TaxProfile — Tax identifiers and elections for an entity. Election state mirrors filings
type TaxProfile struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Ein any `json:"ein,omitempty"`
StateTaxIds map[string]string `json:"state_tax_ids,omitempty"`
SCorpElectionStatus string `json:"s_corp_election_status,omitempty"`
FiscalYearEnd string `json:"fiscal_year_end,omitempty"`
AccountingMethod any `json:"accounting_method,omitempty"`
FirstTaxableYearEnd any `json:"first_taxable_year_end,omitempty"`
BoiFilingStatus string `json:"boi_filing_status,omitempty"`
Elections []TaxElection `json:"elections,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Template
Typed-ID prefix ``. Metadata for a Matter-authored document template that
// Template — Metadata for a Matter-authored document template that
type Template struct {
Object string `json:"object"`
TemplateId string `json:"template_id"`
Name string `json:"name"`
Kind string `json:"kind"`
Category string `json:"category"`
Version string `json:"version"`
Availability string `json:"availability"`
SuccessorTemplateId any `json:"successor_template_id,omitempty"`
CoverPageFieldSchema any `json:"cover_page_field_schema,omitempty"`
AttachableTo []string `json:"attachable_to,omitempty"`
}TemplateClause
Typed-ID prefix tcl_. Content-addressed clause node. The position field encodes the
// TemplateClause — Content-addressed clause node. The `position` field encodes the
type TemplateClause struct {
Object string `json:"object"`
Id string `json:"id"`
RevisionId string `json:"revision_id"`
ParentClauseId any `json:"parent_clause_id,omitempty"`
BodyMdxFragment string `json:"body_mdx_fragment"`
Position map[string]any `json:"position"`
ContentSha256 string `json:"content_sha256"`
IsAttributionNode bool `json:"is_attribution_node,omitempty"`
TemplateSourceId any `json:"template_source_id,omitempty"`
}TemplateRenderJob
Typed-ID prefix trj_. Queued render execution. Drained by the existing BackgroundJob +
// TemplateRenderJob — Queued render execution. Drained by the existing BackgroundJob +
type TemplateRenderJob struct {
Object string `json:"object"`
Id string `json:"id"`
TemplateId string `json:"template_id"`
TemplateRevisionId string `json:"template_revision_id"`
EntityId string `json:"entity_id"`
OrgId string `json:"org_id"`
Jurisdiction string `json:"jurisdiction"`
OverlayHash string `json:"overlay_hash"`
RenderFingerprint string `json:"render_fingerprint"`
AuthorizingTokenId string `json:"authorizing_token_id"`
Mode string `json:"mode"`
Status string `json:"status"`
DocumentId any `json:"document_id,omitempty"`
Error any `json:"error,omitempty"`
QueuedAt string `json:"queued_at"`
StartedAt any `json:"started_at,omitempty"`
CompletedAt any `json:"completed_at,omitempty"`
RenderRegion string `json:"render_region,omitempty"`
}TemplateRevision
Typed-ID prefix trv_. Immutable content-addressed snapshot of a template at a specific
// TemplateRevision — Immutable content-addressed snapshot of a template at a specific
type TemplateRevision struct {
Object string `json:"object"`
Id string `json:"id"`
TemplateId string `json:"template_id"`
Version string `json:"version"`
Sha256 string `json:"sha256"`
Manifest map[string]any `json:"manifest"`
Availability string `json:"availability"`
Visibility string `json:"visibility"`
PublisherOrgId any `json:"publisher_org_id,omitempty"`
ParentRevisionId any `json:"parent_revision_id,omitempty"`
Mode string `json:"mode"`
SourceId any `json:"source_id,omitempty"`
Created string `json:"created"`
CreatedByTokenId any `json:"created_by_token_id,omitempty"`
}TemplateSource
Typed-ID prefix tsr_. Upstream-repo provenance for ingested templates. commit_sha is
// TemplateSource — Upstream-repo provenance for ingested templates. `commit_sha` is
type TemplateSource struct {
Object string `json:"object"`
Id string `json:"id"`
RepoUrl string `json:"repo_url"`
CommitSha string `json:"commit_sha"`
License string `json:"license"`
AttributionText any `json:"attribution_text,omitempty"`
IngestedAt string `json:"ingested_at"`
NormalizerVersion string `json:"normalizer_version"`
}TestClock
Typed-ID prefix clk_. A simulated wall-clock for test-mode entities. Attach entities via
// TestClock — A simulated wall-clock for test-mode entities. Attach entities via
type TestClock struct {
Id string `json:"id"`
Object string `json:"object"`
Name any `json:"name,omitempty"`
FrozenTime int64 `json:"frozen_time"`
Status string `json:"status"`
AttachedEntityCount int64 `json:"attached_entity_count,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}Token
Typed-ID prefix tok_. Scoped access token. sk_live_ / sk_test_ / pk_live_ / pk_test_ are special
// Token — Scoped access token. `sk_live_` / `sk_test_` / `pk_live_` / `pk_test_` are special
type Token struct {
Id string `json:"id"`
Object string `json:"object"`
Tier int64 `json:"tier"`
Scopes []map[string]any `json:"scopes,omitempty"`
Principal map[string]any `json:"principal"`
PortfolioId any `json:"portfolio_id,omitempty"`
Limits map[string]any `json:"limits,omitempty"`
Allowance any `json:"allowance,omitempty"`
ApiVersion string `json:"api_version"`
RevokedAt any `json:"revoked_at,omitempty"`
LastUsedAt any `json:"last_used_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}TopUp
Typed-ID prefix tpu_. One prepaid credit purchase. Created in pending with a hosted checkout
// TopUp — One prepaid credit purchase. Created in `pending` with a hosted checkout
type TopUp struct {
Id string `json:"id"`
Object string `json:"object"`
AccountId string `json:"account_id"`
Amount MonetaryAmount `json:"amount"`
Status string `json:"status"`
Initiator string `json:"initiator"`
CheckoutUrl any `json:"checkout_url,omitempty"`
PaymentMethodType any `json:"payment_method_type,omitempty"`
FailureCode any `json:"failure_code,omitempty"`
LedgerEntryId any `json:"ledger_entry_id,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}Trademark
Typed-ID prefix tmk_. A USPTO trademark application or registration for a mark used by
// Trademark — A USPTO trademark application or registration for a mark used by
type Trademark struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
Mark string `json:"mark"`
DrawingKind string `json:"drawing_kind,omitempty"`
DrawingFileId any `json:"drawing_file_id,omitempty"`
Classes []map[string]any `json:"classes"`
Jurisdiction string `json:"jurisdiction"`
BasisOfFiling string `json:"basis_of_filing"`
Status string `json:"status"`
FirstUseDate any `json:"first_use_date,omitempty"`
FirstUseInCommerceDate any `json:"first_use_in_commerce_date,omitempty"`
SpecimenFileId any `json:"specimen_file_id,omitempty"`
SerialNumber any `json:"serial_number,omitempty"`
RegistrationNumber any `json:"registration_number,omitempty"`
FiledAt any `json:"filed_at,omitempty"`
PublishedAt any `json:"published_at,omitempty"`
NoticeOfAllowanceAt any `json:"notice_of_allowance_at,omitempty"`
RegisteredAt any `json:"registered_at,omitempty"`
RelatedSearchId any `json:"related_search_id,omitempty"`
ApplicationAttributes map[string]any `json:"application_attributes,omitempty"`
StatementOfUse any `json:"statement_of_use,omitempty"`
MaintenanceObligations []map[string]any `json:"maintenance_obligations,omitempty"`
RelatedDocumentId any `json:"related_document_id,omitempty"`
PartnerFilingId any `json:"partner_filing_id,omitempty"`
}TrademarkSearch
Typed-ID prefix tms_. A USPTO TESS search snapshot for a proposed mark + class combination.
// TrademarkSearch — A USPTO TESS search snapshot for a proposed mark + class combination.
type TrademarkSearch struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
Mark string `json:"mark"`
Classes []int64 `json:"classes"`
Jurisdiction string `json:"jurisdiction"`
SearchDate string `json:"search_date"`
Result string `json:"result"`
Conflicts []map[string]any `json:"conflicts,omitempty"`
SnapshotUrl string `json:"snapshot_url,omitempty"`
}Transfer
Typed-ID prefix xfr_. Money movement on a BankAccount — outgoing (initiated via
// Transfer — Money movement on a BankAccount — outgoing (initiated via
type Transfer struct {
Object string `json:"object"`
Id string `json:"id"`
BankAccountId string `json:"bank_account_id"`
TransferKind string `json:"transfer_kind"`
Direction string `json:"direction"`
AmountUsdCents int64 `json:"amount_usd_cents"`
Status string `json:"status"`
Counterparty map[string]any `json:"counterparty,omitempty"`
Memo any `json:"memo,omitempty"`
AuthorizingStakeholderId any `json:"authorizing_stakeholder_id,omitempty"`
InitiatedAt string `json:"initiated_at,omitempty"`
CompletedAt any `json:"completed_at,omitempty"`
PartnerTransferId any `json:"partner_transfer_id,omitempty"`
}TransferAgent
Typed-ID prefix ta_. A third-party transfer agent engaged to manage share certificates,
// TransferAgent — A third-party transfer agent engaged to manage share certificates,
type TransferAgent struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
Provider string `json:"provider"`
ProviderExternalAccountId string `json:"provider_external_account_id"`
EngagedAt string `json:"engaged_at"`
DisengagedAt any `json:"disengaged_at,omitempty"`
Status string `json:"status"`
LastReconciliationAuditId any `json:"last_reconciliation_audit_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
Livemode bool `json:"livemode"`
}TransferAgentReconciliationAudit
Typed-ID prefix tar_. The result of a single reconciliation pass between the transfer
// TransferAgentReconciliationAudit — The result of a single reconciliation pass between the transfer
type TransferAgentReconciliationAudit struct {
Id string `json:"id"`
Object string `json:"object"`
TransferAgentId string `json:"transfer_agent_id"`
EntityId string `json:"entity_id"`
AuditKind string `json:"audit_kind"`
AsOfDate string `json:"as_of_date"`
Status string `json:"status"`
Discrepancies []map[string]any `json:"discrepancies"`
ResolutionCompletedAt any `json:"resolution_completed_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
Livemode bool `json:"livemode"`
}Valuation
Typed-ID prefix val_. 409A valuation event. Compliance tracks expires_at.
// Valuation — 409A valuation event. Compliance tracks `expires_at`.
type Valuation struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
FairMarketValuePerShare MonetaryAmount `json:"fair_market_value_per_share"`
Provider string `json:"provider,omitempty"`
Methodology string `json:"methodology,omitempty"`
EffectiveDate string `json:"effective_date"`
ExpiresAt string `json:"expires_at"`
ReportDocumentId any `json:"report_document_id,omitempty"`
IsSafeHarborCurrent bool `json:"is_safe_harbor_current,omitempty"`
MaterialEventTriggeredAt any `json:"material_event_triggered_at,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}VestingOverlay
Typed-ID prefix vov_. Retroactive vesting layer applied to previously-issued shares. Created
// VestingOverlay — Retroactive vesting layer applied to previously-issued shares. Created
type VestingOverlay struct {
Id string `json:"id"`
Object string `json:"object"`
EntityId string `json:"entity_id"`
LedgerEntryId string `json:"ledger_entry_id"`
GrantId any `json:"grant_id"`
VestingSchedule map[string]any `json:"vesting_schedule"`
AuthorizingResolutionId string `json:"authorizing_resolution_id"`
TaxElectionAcknowledgement map[string]any `json:"tax_election_acknowledgement,omitempty"`
EffectiveDate string `json:"effective_date"`
DocumentId any `json:"document_id,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}WebhookEndpoint
Typed-ID prefix whe_. A subscription target for events. Pins an api_version at creation; payloads never
// WebhookEndpoint — A subscription target for events. Pins an `api_version` at creation; payloads never
type WebhookEndpoint struct {
Id string `json:"id"`
Object string `json:"object"`
Url string `json:"url"`
Description string `json:"description,omitempty"`
EnabledEvents []string `json:"enabled_events"`
ApiVersion string `json:"api_version"`
Include []string `json:"include,omitempty"`
PortfolioId any `json:"portfolio_id,omitempty"`
SigningSecret string `json:"signing_secret,omitempty"`
Status string `json:"status"`
LastDelivery any `json:"last_delivery,omitempty"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}WindDownReserve
Typed-ID prefix wdr_. DGCL §281(b)(iii) reserve. Cash set aside during a wind-down to cover
// WindDownReserve — DGCL §281(b)(iii) reserve. Cash set aside during a wind-down to cover
type WindDownReserve struct {
Object string `json:"object"`
Id string `json:"id"`
EntityId string `json:"entity_id"`
CreditorClaimId string `json:"creditor_claim_id"`
CreditorClaimsWindowId string `json:"creditor_claims_window_id,omitempty"`
Kind string `json:"kind,omitempty"`
CourtPetitionId any `json:"court_petition_id,omitempty"`
HeldAmountUsd float64 `json:"held_amount_usd"`
ReleasedAmountUsd float64 `json:"released_amount_usd,omitempty"`
Status string `json:"status"`
AuthorizingResolutionId string `json:"authorizing_resolution_id,omitempty"`
OpenedAt int64 `json:"opened_at,omitempty"`
ClosedAt any `json:"closed_at,omitempty"`
Created int64 `json:"created"`
Updated int64 `json:"updated"`
Livemode bool `json:"livemode"`
}Workspace
Typed-ID prefix wsp_. Pre-entity container — created BEFORE the entity exists. Holds the document vault,
// Workspace — Pre-entity container — created BEFORE the entity exists. Holds the document vault,
type Workspace struct {
Id string `json:"id"`
Object string `json:"object"`
Name string `json:"name"`
Status string `json:"status"`
ArchivedAt any `json:"archived_at,omitempty"`
EntityIds []string `json:"entity_ids"`
Metadata Metadata `json:"metadata,omitempty"`
Created int64 `json:"created,omitempty"`
Updated int64 `json:"updated,omitempty"`
Livemode bool `json:"livemode"`
}