Carta Liquidity Platform Docs
Twitter
GitHub
Docs
Reference
API
MarketGrid
Services
ACCT
Aggregator
ALGW
Block Signals
Carta Event Bridge
CHGW
Config
DOCS
Frontend
Identity
Issuer Management
MARS
MONY
NOTE
PORT
Reports Generator
Reports Orchestrator
Reports Postgres Sink
REST Gateway
RMAN
RUSE
SETL
Snapshot writer
SOCR
STMT
TAXS
Test
WebSocket server
WERK
Commands
AcceptBlockConfidentialityAgreement
AddAccountUserPermission
AmendBlockSignal
AmendMarsOrder
AssignAccountCoverage
AssignIssuerCoverage
CancelBlockSignal
CancelMarsOrder
ClearReferencePrice
CreateAccessRequest
CreateAccount
CreateAccountProfile
CreateAccountUser
CreateBlockSignal
CreateBlockSignalPortfolios
CreateConfig
CreateEmailRecord
CreateFundingRound
CreateIdentityProvider
CreateIndividualProfile
CreateIssuer
CreateIssuerAccount
CreateLegalEntityProfile
CreateMarsOrder
CreateOrUpdateBlocksSuitabilityProfile
CreateOrUpdateFirmProfile
CreateOrUpdateOrderRequest
CreateOrUpdateRegistrationInvitationEmail
CreateOrUpdateUser
CreateRsuSettlement
CreateSector
CreateTaxWithholdingEstimateDocumentRecordForMarket
CreateTransactionSession
DeleteAccount
DeleteAccountProfile
DeleteAccountUser
DeleteConfig
DeleteFundingRound
DeleteIndividualProfile
DeleteIssuer
DeleteLegalEntityProfile
DeleteOrderRequest
DeleteSector
DeleteTaxWithholdingEstimate
DeleteTransactionSession
DisableAccountCapability
DownloadSocureDocuments
EnableAccountCapability
EnableIssuerSync
ExtInboundTransfer
FinalizeRsuSettlement
FinalizeUserRegistration
GenerateAtsrReport
GenerateCashLedgerReport
GenerateDailyTrialBalanceReport
GenerateIssuerTransactionSummaryReport
GenerateListOfAccountsForMonthlyStatements
GenerateMonthlyStatementForIndividualAccount
GenerateMonthlyStatementsToAccountHolders
GenerateMonthlyStatementsToBeReviewed
GenerateNonTradedParticipantEmails
GenerateReconReport
GenerateSurveillanceReport
GenerateTradeConfirmReport
GenerateTradeConfirmReportForAuction
GenerateTransactionBinderForAccount
GenerateTransactionBinderForAuction
GenerateTransactionDocuments
InboundTransferRequest
InviteUserToBlocks
ManageBlockSignal
MergeStakeholders
PostTaxableTransaction
PublishSecurityLotWithholding
RefreshTaxWithholdingEstimates
ReleaseRequestTaxWithholdingEstimatesVersion
ReleaseSetParticipantSecurityLotVersion
ReleaseSetTaxWithholdingEstimatesVersion
RemoveAccountCoverage
RemoveAccountUserPermission
RemoveIssuerCoverage
RequestTaxWithholdingEstimates
ReserveHolding
SendStakeholderEmails
SendUserRegistrationInvitation
SetParticipantSecurityLot
SetReferencePrice
SetSecurityLotWithholding
SetTaxWithholdingAdjustment
SetTaxWithholdingEstimate
SettleRsuTransaction
StartSocureDocumentVerification
SyncIssuer
TestDateType
TestKeyOfStruct
TestKeyOfUnion
TestMessage
TestMessage2
TestMessage3
TestNil
TestThatHasOutcome
TestYearMonthType
UpdateAccessRequest
UpdateAccount
UpdateAccountProfile
UpdateAccountUser
UpdateAccountUserContactInformation
UpdateAccreditedInvestorAttestation
UpdateConfig
UpdateFundingRound
UpdateIdentityProvider
UpdateIndividualProfile
UpdateInstitutionalAccountAttestation
UpdateIssuer
UpdateIssuerNewActivityConfig
UpdateIssuerView
UpdateLegalEntityProfile
UpdateMarketplaceConfig
UpdateRsuSettlement
UpdateSector
UpdateTransactionSession
UpdateUserCanGenerateAllAccountMonthlyStatements
UpdateUserIsCoverageUser
UpdateUserIsStaff
ValidateTaxWithholdings
Models
AccessRequest
Account
AccountBalanceStatus
AccountCoverageAssignment
AccountDocument
AccountListForMonthlyStatement
AccountProfile
AccountUser
Address
AtsrReport
Auction
AuctionAccount
AuctionAccountDetail
AuctionSession
AuctionSettlementClass
BankTransaction
BeneficiaryProfile
BlockInterestByInvestorMetric
BlockInterestByIssuerMetric
BlockSignal
BlockSignalWorkflow
BlocksSuitabilityProfile
CashLedgerReport
Config
DailyTrialBalanceReport
Document
DocumentGroup
EmailNotificationsMetric
EmailRecord
EquityClass
ExtInboundTransferAck
FirmProfile
FundingRound
GovernmentId
Holding
HoldingReservation
HoldingTransaction
IdentityProvider
IndividualProfile
Instrument
InvestorProfile
InvestorTag
Issuer
IssuerCoverageAssignment
IssuerDashboardElectionDetailsMetric
IssuerDashboardParticipantEngagementMetric
IssuerDashboardRelationshipSummaryMetric
IssuerDashboardSubscriptionRateMetric
IssuerMarketSyncCompleted
IssuerNewActivityConfig
IssuerNote
IssuerOrdersMetric
IssuerPrivateData
IssuerSync
IssuerTransactionSummaryReport
IssuerView
LegalDocument
LegalEntityProfile
ListingProfile
Market
MarketplaceConfig
MarketplaceDashboardMetric
MarketSettlementClass
MarsAccount
MarsOrder
MarsOrderGroup
MonthlyStatementReport
MonthlyStatementsToBeReviewed
NdaSignature
NonTradedParticipantEmails
OptionExercise
OrderRequest
Outcome
Participant
ParticipantEmailRecordDetailsMetric
ParticipantRelationshipExternalDisplayType
ParticipantSecurityLot
ParticipantSecurityLotCsvDownloaded
ParticipantSecurityLotsCreated
PortDataIntegrityError
PortfolioIssuerMetric
PortfolioSecurityMetric
PortfolioSharedMetrics
ReconReport
ReferencePrice
RegistrationInvitationEmail
RegistrationInvitationState
ReserveHoldingError
RollupStakeholder
RsuScheduledForSettlement
RsuSchedulingCompleted
RsuSettled
RsuSettlement
RsusToReleaseMetric
RsuUnscheduledForSettlement
RsuUnsettled
Sector
SecuritiesCommandError
Security
SecurityAllocation
SecurityLotWithholding
SecuritySold
SecurityValues
SettlementClass
SettlementInstruction
SnapshotIndex
SocureDocumentVerification
Stakeholder
StartSocureDocumentVerificationError
SurveillanceReport
TaxWithholdingAdjustment
TaxWithholdingEstimate
TaxWithholdingEstimateCsvDownloaded
TaxWithholdingEstimateDocumentRecordForMarket
TaxWithholdingEstimatesCreated
TestModel
TestUuidPrimaryKey
Trade
TradeConfirmReport
TradePairing
TransactionBinderReport
TransactionDepositsSummaryMetric
User
VRNCountStatus
Legacy events
AccountBalance
AccountBalanceStatus
AccountChange
AccountNew
ActivateAccount
AddAccountToAuction
AlloyIndividualEvaluationRequest
AlloyIndividualEvaluationResponse
AuctionAccountChange
AuctionAccountNew
AuctionChange
AuctionNew
AuctionSessionChange
BankTransactionData
BulkMultiClassOrderNew
BulkOrderCancel
BulkOrderNew
CcmxKafkaHB
CloseAccount
ConfirmedSellerAllocation
CreateAccount
CreateAuction
CreateAuctionAccountRelationship
CreateAuctionSession
CreateInstrument
CreateIssuer
CreateLegalDocument
CreateMarketEligibleEquityClass
CreateOptionExercise
CreateSecuritySold
CreateSettlementClass
DeactivateAccount
DeleteAccount
DeleteAuction
DeleteAuctionAccountRelationship
DeleteAuctionSession
DeleteInstrument
DeleteIssuer
DeleteLegalDocument
DeleteSettlementClass
EquityClassCreated
EquityClassUpdated
Error
ExtOutboundTransfer
ExtOutboundTransferAck
ExtOutboundTransferError
ExtPaymentTrackAndTrace
ExtPaymentTrackAndTraceData
ExtPaymentTrackAndTraceError
ExtTransactionDetails
ExtTransactionDetailsData
GenerateIssuerConfirm
GenerateTradeConfirm
GenerateTransactionBinder
HoldingAllocationMulti
HoldingData
HoldingTransaction
HoldingTransactionConfirm
HoldingTransactionData
HoldingTransactionMulti
HoldingTransactionStatus
InviteAccountForAuction
IssuerTransactionSummaryGeneratedEvent
KafkaTransactionEnd
NewVirtualReferenceNumber
NotionalOrderAmend
NotionalOrderCancel
NotionalOrderNew
OpenAccount
OrderAmend
OrderCancel
OrderCancelAllForAccount
OrderCancelAllForAuction
OrderCancelAllForAuctionAccount
OrderMultiCancel
OrderNew
OrderRelease
OrderReleaseAllForAccount
OrderReleaseAllForAuction
OrderReleaseAllForAuctionAccount
OutboundTransferRequest
OutboundTransferRequestError
PreliminaryExternalCosts
ProposedSellerAllocation
ProvisionalSecuritiesSold
RemoveAccountFromAuction
RmanInternalPhaseChange
RollupStakeholderUpdated
SendEmail
SendSlackMessage
SendSpousalConsentReminderEmails
SendUserEmails
SetAccountSoftBlock
SetAccountVRN
SetAuctionAccountConsentRequired
SetAuctionAccountEligibleQuantity
SetAuctionAccountIsFunding
SetAuctionAccountSignatureRequired
SetAuctionAllowUnfunded
SetAuctionSession
SetAuctionSettlementClasses
SetParticipantPriority
SetParticipantSortOrder
SettlementStatus
StatementGeneratedEvent
StockPurchaseAgreementGeneratedEvent
TradeConfirmGeneratedEvent
TradeSettle
TradeUpdateValues
TransferAuctionTradeFees
TriggerAuctionSession
TriggerAuctionSettlement
TriggerAuctionTaxCalculation
TriggerTenderOfferProposedTrades
UndeleteAccount
UpdateAccount
UpdateAuction
UpdateAuctionAccount
UpdateAuctionAccountRelationship
UpdateAuctionSession
UpdateInstrument
UpdateIssuer
UpdateMarketEligibleEquityClass
UpdateSettlementClass
VRNCount
VRNCountStatus
Structs
AccessRequestAccountError
AccessRequestAlreadyExist
AccessRequestDoesNotExist
AccessRequestSetupIncomplete
Account
AccountAlreadyHasActiveSignalForInstrumentAndSide
AccountDoesNotExist
AccountMetaData
AccountProfileDoesNotExist
AccountsDisjoint
AccountsMissing
AccountUserDoesNotExist
AccountUserPermissionDoesNotExist
AccountUserPermissionNotAllowed
AccountWorkflowStepDetails
AccountWorkflowStepsCompleted
ActionInvalidForCurrentTransactionPhase
ActionInvalidForTransactionType
AlreadyExists
AuctionMetaData
AuctionNotFoundError
BankAccount
BankAccountBalance
BlockSignalNotActive
BlockSignalShareClassQuantities
BlockSignalTotalQuantity
BlockSignalWorkflowNote
BlocksInviteExistingAccount
BlocksInviteExistingAccountUser
BlocksInviteNewAccount
BlocksInviteNewAccountUser
BlocksInviteRegisterCartaUser
CartaEventSecuritiesCommandErrorDetailV1
CartaEventSecurityV1
CashWithheldGreaterThanTotalTaxWithholdingEstimate
CashWithheldLessThanZero
ConfigAlreadyExists
ConfigDoesNotExist
ConflictingBatchActionInProgress
DatabaseWriteError
DateMustNotBeInPast
DatetimeMustNotBeInPast
DatetimeWithinCutoffWindow
DeletingIssuerWouldLeaveHangingReferences
DoesNotExist
ElectionStartTimeGreaterThanEndTime
ElectionStartTimeMustNotBeInPast
EmailRecipient
EquityClassMustHaveFmvOrFmvTaxWhSet
EquityClassMustNotHaveFmvAndFmvTaxWhSet
EventSummary
ExternalBankAccount
ExternalBankAccountAddress
ExternalBankAccountBankDetails
ExternalBankAccountForFurtherCreditDetails
ExternalBankAccountIntermediaryAccountDetails
ExternalBankAccountRecipientDetails
ExternalBankDetails
ExternalEntityDetails
ExternalIntermediaryAccountDetails
FieldNotMutable
FieldRequiredError
FinalizeRsuSettlementErrors
Flags
FrozenWithholdingError
FundingRoundAlreadyExists
FundingRoundDoesNotExist
GenericError
GrpcServiceError
HoldingTransactionDataMetadata
IamUserNotFound
IdentityProviderAlreadyExists
IncorrectParticipantSecurityLotVersion
IncorrectTaxWithholdingEstimateVersion
IndividualProfileDoesNotExist
InsufficientCommonHoldings
InsufficientOptionHoldings
InsufficientPreferredHoldings
InsufficientTotalHoldings
InvalidAccount
InvalidAccountAccountUserCombination
InvalidAccountName
InvalidAccountStatus
InvalidAccountType
InvalidBlockSignal
InvalidChoice
InvalidDateFormat
InvalidDatetimeFormat
InvalidEligibleEquityClass
InvalidEmailAddress
InvalidEmailBody
InvalidEmailButtonText
InvalidEmailFooter
InvalidEmailSubject
InvalidExtEntityId
InvalidExtEntityType
InvalidExtEntityUuid
InvalidIdentityProvider
InvalidIssuer
InvalidNewWorkflowStatus
InvalidNumber
InvalidParticipantSecurityLotQuantity
InvalidPhaseForCommand
InvalidPhoneNumber
InvalidPositiveInteger
InvalidProduct
InvalidTaxWithholdingItemsError
InvalidUrl
InvalidUser
InvestorFinancedOptionCashExercised
IssuerAccountDoesNotExist
IssuerAccountNotActive
IssuerAlreadyExists
IssuerByAccount
IssuerByCincCorporationId
IssuerById
IssuerByPitchbookId
IssuerCitation
IssuerCitationString
IssuerDoesNotExist
IssuerTradeDetail
LegalEntityProfileDoesNotExist
MarketplaceExperienceMetadata
ModelDoesNotExist
MonthlyStatementsTopLevelAccountFetchError
MultipleStakeholderError
NoEffect
NotBrokerageAccount
NotFirmAccount
Notional
NotTopLevelAccount
OK
OptionExercise
OutboundTransferRequestErrorErrors
OutboundTransferRequestErrorResults
OutboundTransferRequestTransferDetails
ParticipantNotAddedToMarket
ParticipantSecurityLotDoesNotExist
ParticipantSecurityLotsNotConfirmed
Payment
PerAccountTradeDetail
PostalAddress
PreviousSetSecurityLotWithholdingCommandInProgress
PriceAndQuantity
ProceedsToPayroll
QuantityWithheldLessThanZero
QuantityWithheldNotExpected
ReferencePriceHasNoteWithSameValue
ReferencePriceLowPriceMustBeLessThanHighPrice
ReferencePriceMustHaveLowOrHighPrice
RegistrationInvitationEmailNotFound
RegistrationInvitationEmailValidationError
RegistrationInvitationForStateNotFound
RegistrationInvitationStateDoesNotExist
ReportCompleted
ReportFailed
ReportGenerated
ReportRequested
ReserveHoldingFailed
RsuSettlements
RsuSettlementValidationError
SectorAlreadyExists
SectorDoesNotExist
SecuritiesSold
SettlementClassInfo
SettlementDateBeforeStartDateError
StakeholderDoesNotExist
TaxAdjustmentSecurity
TaxRequestInput
TaxWithholdingDoesNotExist
TaxWithholdingEstimateDoesNotExist
TaxWithholdingEstimatesNotConfirmed
TaxWithholdingItem
TestStruct
TestStruct2
TradeConfirmParentAccountFetchError
TradePairs
TradeSummary
TradeTransaction
Transaction
TransactionBinderTradePairFetchError
TransactionDetailsAccount
TransactionDoesNotExist
TransactionSkipsWithholdingError
TransactionSourceAccount
TransactionSourceAccountDetails
TransactionSourceAccountFull
TransferBankDetails
TransferDestinationAccount
TransferDetails
TransferExtraDetails
TransferFurtherCredit
TransferIntermediaryBankDetails
TransferInternalAccount
TransferInternationalExtraFields
TransferPostalAddress
TransferRecipientDetails
TransferSourceAccount
Unauthorised
UnknownError
UnknownTaxableTransactionError
UnsupportedIssuerSelector
UsdInstrumentDoesNotExist
UserAlreadyExistsOnAccount
UserDoesNotExist
UserIsAlreadyStaff
UserIsNotCoverageUser
UserIsNotStaff
UtmParameters
VestingEndDateAfterSettlementDate
Enums
AccessRequestExperience
AccessRequestSource
AccessRequestStatus
AccountCapability
AccountDocumentKind
AccountStatus
AccountType
AccountUserPermission
AccountUserStatus
AccountWorkflowStepType
AccountWorkflowType
AlloyEvaluationType
AlloyOutcome
AssetsUnderManagement
AuctionExtensionReason
AuctionPhase
AuctionPhaseActive
AuctionType
AverageCheckSize
BankTransactionInitiator
BankTransactionStatus
BankTransactionType
BankTransferMethod
BankTransferRegion
BeneficiaryRelationship
BeneficiaryType
BlockSignalStatus
BlockSignalWorkflowStatus
CartaEventRsuCommandType
CartaEventSecurityType
CcmxAccountRelationship
Command
ConfigErrorKey
ConfigKey
CorporationRelationship
CreditDebit
DownturnDisposition
EducationCompleted
EmailRecipientKind
EmailTemplateType
EmailType
EmploymentStatus
EquityClassSource
EquityClassStockType
ExemptCode
ExtEntityType
ExternalBankAccountRecipientType
ExternalContactType
ExtOrgType
FederalTaxClassification
FeeBasis
FinancialEntityType
ForeignCitizenType
GovernanceDocumentType
GovernmentIdType
HoldingReservationType
HoldingTransactionAction
HoldingTransactionExternalStatus
HoldingTransactionPaymentType
HoldingTransactionSource
HoldingTransactionStatus
HoldingTransactionType
IdentityProviderStrategy
InstrumentType
InvestmentExperience
InvestmentObjective
InvestmentStage
InvestmentTimeline
InvestorType
IsoSubFamily
IssuerActivity
IssuerUsage
LegalDocumentType
LiquidityImportance
LiquidNetWorth
MaritalStatus
MarketplaceExperienceRequestPermission
MarketplaceNoExperienceReason
MarketType
MarsStatus
MarsTable
Model
MoneyRange
MunicipalEntityType
NetFundingType
OrderReason
OrderSide
OrderSides
OrderStatus
PortDataIntegrityErrorType
PortDataIntegrityResolutionType
RegistrationInvitationEmailInviteType
RegistrationInvitationExperience
ReservationDeficitType
ReservationOperation
RmanInternalPhase
RollupStakeholderRelationshipType
RoundingMethod
RsuSettlementSchedulingStatus
RsuSettlementType
SecuritySource
Session
SettlementDataType
SettlementStatusPhase
SettlementStatusStatus
ShareTransferType
SocureDocumentVerificationStatus
StakeholderType
TaxEstimateRequestType
TaxStatus
TaxWithholdingType
TenderOfferAllocationMethod
TestEnum
TradeCostsAction
TradePairingStatus
TradeReason
TradeSettlementType
TradeStatus
TransferRestrictionStatus
Reference
API and data model reference guide
Services →
Services
Commands →
Commands
Models →
Models
Legacy events →
Legacy events
Structs →
Structs
Enums →
Enums