REST Gateway
repo | definitionThe REST API server for submitting commands into the system.
The REST API server for submitting commands into the system.
Events
Consumed
Models
Consumes the following 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
- Trade
- TradeConfirmReport
- TradePairing
- TransactionBinderReport
- TransactionDepositsSummaryMetric
- User
- VRNCountStatus
Produced
Commands
Produces the following 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
- UpdateAccessRequest
- UpdateAccount
- UpdateAccountProfile
- UpdateAccountUser
- UpdateAccountUserContactInformation
- UpdateAccreditedInvestorAttestation
- UpdateConfig
- UpdateFundingRound
- UpdateIdentityProvider
- UpdateIndividualProfile
- UpdateInstitutionalAccountAttestation
- UpdateIssuer
- UpdateIssuerNewActivityConfig
- UpdateIssuerView
- UpdateLegalEntityProfile
- UpdateMarketplaceConfig
- UpdateRsuSettlement
- UpdateSector
- UpdateTransactionSession
- UpdateUserCanGenerateAllAccountMonthlyStatements
- UpdateUserIsCoverageUser
- UpdateUserIsStaff
- ValidateTaxWithholdings
Models
Produces the following models:
Legacy events
Produces the following 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