Trades
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
string · min: 1 · max: 50OptionalExample:
tid_00041061050r3gg28a1c60t3gfQuery parameters
investmentTypestring · enumOptionalPossible values:
tradeStatusstring · enumOptionalPossible values:
saStatusstring · enumOptionalPossible values:
saCheckstring · enumOptionalPossible values:
txnPaymentMethodstring · enumOptionalPossible values:
fundingStatusstring · enumOptionalPossible values:
txnCheckstring · enumOptionalPossible values:
systemReviewCheckstring · enumOptionalPossible values:
complianceReviewstring · enumOptionalPossible values:
beenDisbursedstring · enumOptionalPossible values:
searchstringOptionalExample:
MikeofferingIdanyOptionalExample:
offering_00041061050r3gg28a1c60t3gffromstring · nullableOptionalExample:
MM/DD/YYYYtostring · nullableOptionalExample:
MM/DD/YYYYminAmountanyOptionalExample:
2500.00maxAmountanyOptionalExample:
15000000.50managedBystring · enumOptionalPossible values:
investorAccountIdanyOptional
includestringOptionalExample:
tradeDisbursements,adjustments,account,issuer,lineItems,transactions,investorAccount,offering,paymentMethodResponses
200
200
application/json
idstringRequiredExample:
entityprefix_01j1xgme5qeqq97gpdztd7e4a6__entitystringOptionalExample:
EntitycreatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
updatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
deletedAtone of · nullableRequiredExample:
2026-03-27T15:47:09.540Zstring · date-timeOptional
string · date-timeOptional
investorAccountIdany · nullableRequired
investorAccountany · nullableOptional
offeringany · nullableOptional
accountIdstring · nullableRequiredExample:
account_01j1xgme5qeqq97gpdztd7e4a6accountany · nullableRequired
offeringIdany · nullableRequired
paymentMethodIdany · nullableRequired
paymentMethodany · nullableOptional
userIdany · nullableRequired
tradeNumberstringRequired
ipstring · nullableRequired
tidstring · nullableRequired
investmentTypestring · enumRequiredPossible values:
purchasedSharesintegerRequired
bonusSharesinteger · nullableRequired
totalNumberOfSharesintegerRequired
pricePerSharenumberRequired
totalAmountnumber · nullableRequired
tradeStatusstring · enumRequiredPossible values:
tradeStatusUnmappedstring · nullableRequired
tradeDatestring · date-time · nullableRequired
saStatusstring · enumRequiredPossible values:
saStatusUnmappedstring · nullableRequired
saUrlstring · nullableRequired
saSignedAtstring · date-time · nullableRequired
saExtractedNumberOfSharesstring · nullableRequired
saExtractedTotalAmountstring · nullableRequired
saExtractedPricePerSharestring · nullableRequired
saExtractedInvestorTypestring · nullableRequired
saExtractedSignerstring · nullableRequired
saExtractedSignatureDatestring · date-time · nullableRequired
saExtractedSigner2string · nullableRequired
saExtractedSignatureDate2string · date-time · nullableRequired
saCheckstring · enumRequiredPossible values:
saCheckedAtstring · date-time · nullableRequired
txnTidstring · nullableRequired
txnResponsestring · nullableRequired
txnPaymentMethodstring · enum · nullableRequiredPossible values:
txnCurrencyCodestring · min: 3 · max: 3 · nullableRequired
txnChargedAmountnumber · nullableRequired
txnDatestring · date-time · nullableRequired
txnSettledDatestring · date-time · nullableRequired
fundingStatusstring · enum · nullableRequiredPossible values:
fundingStatusUnmappedstring · nullableRequired
txnCheckstring · enum · nullableRequiredPossible values:
txnCheckedAtstring · date-time · nullableRequired
txnLogstring · nullableRequired
systemReviewCheckstring · enum · nullableRequiredPossible values:
systemReviewCheckedAtstring · date-time · nullableRequired
systemReviewLogstring · nullableRequired
complianceReviewstring · enum · nullableRequiredPossible values:
complianceReviewNotesstring · nullableRequired
complianceReviewerIdstring · nullableRequired
issuerIdany · nullableRequired
complianceReviewNamestring · nullableRequired
complianceReviewAtstring · date-time · nullableRequired
tradeTypestring · enum · nullableRequiredPossible values:
placedAtstring · date-time · nullableRequired
platformstringRequired
cancelledAtstring · date-time · nullableRequired
cancelledByIdstring · nullableRequired
cancelledReasonstring · nullableRequired
cancellationPeriodnumber · nullableRequired
disbursedbooleanOptional
tradeAdjustmentsnumber · nullableOptional
chargedAmountnumber · nullableOptional
balancenumber · nullableOptional
isUncleared24hbooleanRequired
termnumber · nullableRequired
exercisePricenumber · nullableRequired
warrantPercentagenumber · nullableRequired
calculationMethodstring · enum · nullableRequiredPossible values:
incrementThresholdnumber · nullableRequired
401
401
application/json
403
403
application/json
404
404
application/json
get
/clients/api/v1/trades/{id}Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
string · min: 1 · max: 50OptionalExample:
tid_00041061050r3gg28a1c60t3gfBody
tradeStatusstring · enumRequiredPossible values:
Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
patch
/clients/api/v1/trades/{id}Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10investmentTypestring · enumOptionalPossible values:
tradeStatusstring · enumOptionalPossible values:
saStatusstring · enumOptionalPossible values:
saCheckstring · enumOptionalPossible values:
txnPaymentMethodstring · enumOptionalPossible values:
fundingStatusstring · enumOptionalPossible values:
txnCheckstring · enumOptionalPossible values:
systemReviewCheckstring · enumOptionalPossible values:
complianceReviewstring · enumOptionalPossible values:
beenDisbursedstring · enumOptionalPossible values:
searchstringOptionalExample:
MikeofferingIdanyOptionalExample:
offering_00041061050r3gg28a1c60t3gffromstring · nullableOptionalExample:
MM/DD/YYYYtostring · nullableOptionalExample:
MM/DD/YYYYminAmountanyOptionalExample:
2500.00maxAmountanyOptionalExample:
15000000.50managedBystring · enumOptionalPossible values:
investorAccountIdanyOptional
includestringOptionalExample:
tradeDisbursements,adjustments,account,issuer,lineItems,transactions,investorAccount,offering,paymentMethodResponses
200
200
application/json
401
401
application/json
403
403
application/json
get
/clients/api/v1/tradesAuthorizations
X-API-KEYstringRequired
Query parameters
resetstringOptionalDefault:
falseBody
assetIdstringRequiredExample:
asset_00041061050r3gg28a1c60t3gfquantitynumber · max: 1000000000Required
Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
post
/clients/api/v1/trades/line-itemsAuthorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
string · min: 1 · max: 50OptionalExample:
tid_00041061050r3gg28a1c60t3gfBody
lineItemIdstringRequiredExample:
trade_line_item_01kctsycw3fq7sj6hedvy62cjafileIdanyRequiredExample:
file_01je6ht4b8fbmttkzh2hs82xqpprimarySignatureStatusstring · enumRequiredExample:
SIGNEDPossible values: secondarySignatureStatusstring · enumOptionalExample:
SIGNEDPossible values: Responses
200
200
application/json
successbooleanRequired
messagestringRequired
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
post
/clients/api/v1/trades/{id}/attach-subdocAuthorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
string · min: 1 · max: 50OptionalExample:
tid_00041061050r3gg28a1c60t3gfBody
lineItemIdstringOptionalExample:
trade_line_item_01kctsycw3fq7sj6hedvy62cjafileIdanyOptionalExample:
file_01je6ht4b8fbmttkzh2hs82xqpprimarySignatureStatusstring · enumOptionalExample:
SIGNEDPossible values: secondarySignatureStatusstring · enumOptionalExample:
SIGNEDPossible values: Responses
200
200
application/json
successbooleanRequired
messagestringRequired
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
put
/clients/api/v1/trades/{id}/attach-subdocAuthorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
string · min: 1 · max: 50OptionalExample:
tid_00041061050r3gg28a1c60t3gfBody
lineItemIdstringOptionalExample:
Optional. If not provided, updates the first line item with an attached subdoc. Required for trades with multiple line items.
trade_line_item_01kctsycw3fq7sj6hedvy62cjaprimarySignatureStatusstring · enumOptionalExample:
Primary signer signature status
SIGNEDPossible values: secondarySignatureStatusstring · enumOptionalExample:
Secondary signer signature status. Only applicable for JOINT investor accounts.
SIGNEDPossible values: Responses
200
200
application/json
successbooleanRequired
messagestringRequired
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
patch
/clients/api/v1/trades/{id}/signLast updated