All Endpoints¶
Every TransactAPI endpoint, grouped by topic. Each entry links to its full reference — parameters, example request and response, and errors.
This page is generated from the reference pages by scripts/generate-endpoint-index.py. Edit the reference page, not this page.
Accounts¶
| Endpoint | Description |
|---|---|
GET /v3/accounts | Fetch a list of account resources associated with this client. |
GET /v3/accounts/{accountId} | Fetch a single account resource by ID. |
PATCH /v3/accounts/{accountId} | Update specific fields on a single account. |
POST /v3/addAccountNote | Adds a note to a specific account. |
PUT /v3/calculateSuitability | This method is used to add investment suitability information to an account (createAccount). |
PUT /v3/createAccount | This method is used to create an account that can be linked (createLink) to an individual party (createParty) or an entity (createEntity). |
POST /v3/deleteAccount | This method is used to delete an account that is created for an individual party or entity party. |
POST /v3/deleteAccountDocument | This method is used to delete the account document upload. |
POST /v3/deleteSuitability | This method is used to delete investment suitability for an account(createAccount). |
POST /v3/getAccount | Deprecated. This method is used to get all information for an account (createAccount). |
POST /v3/getAccountDocument | This method is used to retrieve the information for all documents (uploadAccountDocument) that are associated with a particular account. |
POST /v3/getAccountNotes | Deprecated. This endpoint is deprecated and may be removed in a future version. |
POST /v3/getAllAccounts | Deprecated. Pulls all accounts for the client. |
POST /v3/getSuitability | This method is used to retrieve all suitability information for a specific account. |
POST /v3/searchAccount | Deprecated. This method is used to search all accounts for a specific keyword within the account information. |
PUT /v3/updateSuitability | This method is used to update investment suitability information for an account (createAccount) |
PUT /v3/updateAccount | This method is used to update a specific account (updateAccount) |
POST /v3/updateAccountArchiveStatus | Used to update an account to Archive status. |
Parties¶
| Endpoint | Description |
|---|---|
PUT /v3/createEntity | This method is used to create an Entity Party in TransactAPI. |
PUT /v3/createParty | This method is used to create an individual Party in TransactAPI. |
POST /v3/deleteEntity | This method is used to delete a particular entity party. |
POST /v3/deleteEntityDocument | This method is used to delete a document from a particular Entity (uploadEntityDocument). |
POST /v3/deleteParty | This method is used to delete a particular individual party. |
POST /v3/deletePartyDocument | This method is used to delete a document from a particular party (uploadPartyDocument). |
GET /v3/entities | Fetch a list of entity resources associated with this client. |
POST /v3/getAllParties | Deprecated. Get all parties for a given client. |
POST /v3/getEntity | This method is used to get information about an Entity Party. |
POST /v3/getEntityDocument | This method is used to get all information about individual Entity document. |
POST /v3/getParty | This method is used to get all information about an individual Party. |
POST /v3/getPartyDocument | This method is used to get all information about individual Parties document. |
GET /v3/parties | Fetch a list of party (legal person) resources associated with this client. |
GET /v3/parties/{partyId} | Fetch a single party resource by ID. |
POST /v3/searchEntity | This method is used to search all entity parties for a specific keyword within the party information and will return all matches for that keyword. |
POST /v3/searchParty | This method is used to search all individual parties for a specific keyword within the party information and will return all matches for that keyword. |
POST /v3/updateEntity | This method is used to update fields related to a particular entity party record in TransactAPI. |
POST /v3/updateParty | This method is used to update fields related to a particular individual party record in TransactAPI. |
POST /v3/updatePartyEntityArchivestatus | Update the archive status of a party or entity. |
Offerings¶
| Endpoint | Description |
|---|---|
POST /v3/cancelOffering | Cancels the offering: the stored offeringStatus becomes cancelled. |
POST /v3/closeOffering | This method closes the offering and cannot be invoked until all trade statuses are one of the following: Funded, Settled, Unwind Settled, Rejected, or Canceled. |
PUT /v3/createOffering | This method is used to create an offering/deal in TransactAPI. |
POST /v3/deleteOffering | This method deletes an offering. |
POST /v3/getAllOffers | Deprecated. Get all offers for a given client |
POST /v3/getCustodianDetailsforOffering | Retrieves the wire and check funding instructions for the custodian associated with a specific offering. |
POST /v3/getOffering | This method is used to get all the details of an offering. |
POST /v3/getOfferingDetails | Returns aggregate funding totals for an offering along with its escrow account number. |
POST /v3/getOfferingPurchaseHistory | This method is used to retrieve the history of all trades (and details of the trades) created for an offering. |
POST /v3/getOfferingStatus | This method is used to retrieve the approval status of a specific offering. |
GET /v3/offerings | Fetch a list of offering resources associated with this client. |
POST /v3/searchOffering | This method is used to search all created offerings using a keyword and will return all matches for that keyword. |
POST /v3/updateOffering | This method is used to update an offering in TransactAPI. |
POST /v3/updateOfferingDocument | Updates the metadata (title) of a document previously attached to an offering. |
Trades¶
| Endpoint | Description |
|---|---|
POST /v3/addTradeNote | This method adds a note to a trade (createTrade). |
POST /v3/cancelInvestment | This API will perform all of the functions necessary to fully cancel and/or refund an investment. |
POST /v3/createTrade | This method is used to create a trade/investment for an offering. |
POST /v3/deleteTrade | This method is used to delete (status is changed to "Canceled") a particular Trade from TransactAPI. |
POST /v3/deleteTradeNote | This method deletes a trade note (addTradeNote) by its note ID. |
PUT /v3/editTrade | This method is used to edit a particular Trade from TransactAPI. |
POST /v3/editTradeUnits | This method updates the unit price and number of units/shares for an existing trade. |
POST /v3/fundReturnRequest | Deprecated. This method is used to request funds be returned to an investor. |
POST /v3/getAccountTradeHistory | This method will return all the trade information for all trades created for a particular Account (createAccount). |
POST /v3/getAllTrades | Deprecated. Get All trades for a given client. |
POST /v3/getPaymentInfo | This method returns the full trade record for a single trade, together with payment-processor details for the associated fund move. |
POST /v3/getTrade | This method is used to get the all the details of all the trades for an account. |
POST /v3/getTradeNote | This method retrieves all notes recorded against a trade (createTrade). |
POST /v3/getTradesForOffering | This method is used to retrieve the history of all trades (and details of the trades) created for an offering. |
POST /v3/getTradeStatus | This method is used to get the current trade details as an array with the current trade status |
GET /v3/trades | Fetch a list of trade resources associated with this client. |
POST /v3/updateTradeNote | This method updates the author or text of an existing trade note (addTradeNote). |
POST /v3/updateTradeStatus | This method is used to update the status of a trade. |
POST /v3/updateTradeTransactionType | Update trade transaction type |
Documents¶
| Endpoint | Description |
|---|---|
POST /v3/addDocumentsforOffering | This method is used to add a document to an offering. |
POST /v3/addSubscriptionsforOffering | This method is used to add Subscription Documents to the offering through DocuSign. |
POST /v3/deleteDocumentsforOffering | This method is used to delete a document from an offering (addDocumentsforOffering). |
POST /v3/deleteSubscriptionsforOffering | This method is used to delete a Subscription Document from the offering. |
POST /v3/deleteAccountDocument | Delete account documents. |
POST /v3/deleteTradeDocument | Delete a trade document. |
POST /v3/fetchSubscriptionDocuments | This method retrieves all subscription document templates available in the client's connected DocuSign account. |
POST /v3/getAllSignedDocument | Get all signed document details |
POST /v3/getDocumentsforOffering | This method is used to retrieve the document URL path and document details for a particular offering document (addDocumentsforOffering). |
POST /v3/getSubscriptionsforOffering | This method is used to retrieve the subscription document template details for a particular offering. |
POST /v3/getTradeDocument | getTradeDocument list |
POST /v3/getTradeSignedDocument | This method retrieves the signed subscription documents for a trade (createTrade). |
POST /v3/getuploadPartyDocument | This method will return the document URL path and document details for a particular party document. |
POST /v3/requestUploadPartyDocument | This method is used to collect documents when North Capital is providing a manual review of KYC/AML. |
POST /v3/resendSubscriptionDocuments | The Resend Subscription Documents endpoint handles the re-delivery of previously sent subscription documents to investors. |
POST /v3/sendNda | This method is used to send the subscription documents to sign. |
POST /v3/sendSubscriptionDocument | Sends the offering's subscription documents to the trade's primary party for electronic signature by DocuSign email. |
POST /v3/sendSubscriptionDocumentClient | Create a DocuSign envelope and provide a URL to a view where the envelope can be signed. |
POST /v3/updateDocumentforOffering | This method is used to update a document with a new document for an offering. |
POST /v3/updateSubscriptionsforOffering | This method is deprecated and should not be used for new integrations. |
POST /v3/updateTradeDocArchivestatus | Update trade document archive status |
POST /v3/uploadAccountDocument | This method uploads a document and associates it with an account (createAccount). |
POST /v3/uploadEntityDocument | This method is used to upload a document to a particular entity party (createEntity). |
POST /v3/uploadPartyDocument | This endpoint is used to upload a document and associate it with an individual party. |
POST /v3/uploadTradeDocument | This method is used to upload a document to a particular trade (createTrade). |
KYC / AML¶
| Endpoint | Description |
|---|---|
POST /v3/deleteKycAml | This method is used to delete KYC/AML details of a particular party from TransactAPI. |
POST /v3/getKycAml | This method returns the current KYC and AML review status for a single party. |
POST /v3/getKycAmlResponse | This method is used to get all information about an individual Party. |
POST /v3/performAml | Perform AML(Anti-Money Laundering) Checks for Entity Parties(createEntity). |
POST /v3/performKycAml | This method is used to perform KYC(Know Your Customer) checks and AML(Anti-Money Laundering) checks for Individual Parties Contact techsupport@northcapital.c… |
POST /v3/performKycAmlBasic | This method is used to perform KYC(Know Your Customer) checks and AML(Anti-Money Laundering) checks for Individual Parties Contact techsupport@northcapital.c… |
POST /v3/requestKycAml | This method is used to request that KYC & AML be manually verified. |
PUT /v3/updateKycAml | This method is used to verify the KYC(Know Your Customer) Status, after the 'performKycAml' autocheck is done. |
POST /updateKycAmlStatus | This method is used only when performing a manual KYC/AML review (see requestKycAml). |
Accreditation Verification¶
| Endpoint | Description |
|---|---|
POST /v3/getAiDocument | This method is used to retrieve a list of all accreditation documents associated with a specific account. |
POST /v3/getAiLetter | This method is used to retrieve the letter verifying Accredited Investor (requestAiVerification) status for a specific account. |
POST /v3/getAiRequest | This method is used to retrieve the status of an accreditation verification request (requestAiVerification) for a specific account. |
POST /v3/requestAiVerification | This is used to send a request to verify the accredited status of an Account (createAccount). |
POST /v3/updateAiRequest | This method is used to update the status of the submitted Accredited Investor verification request. |
POST /v3/uploadVerificationDocument | This method is used to upload documentation to verify Accredited Investor status to a specific account. |
ACH Transfers¶
| Endpoint | Description |
|---|---|
POST /v3/createExternalAccount | This method is used to add information to an Account (createAccount) for an external bank account which an ACH transfer can be initiated from. |
POST /v3/deleteExternalAccount | This method is used to delete a particular external bank account (createExternalAccount) that was created for an account (createAccount). |
POST /v3/externalFundMove | This method is used to initiate an ACH debit that moves funds from an investor's external bank account into the escrow account for the offering. |
POST /v3/getAchPendingId | This method returns the pending Tristate ACH fund-move transactions for an account. |
POST /v3/getExternalAccount | This method retrieves the external bank account (createExternalAccount) linked to an account or issuer. |
POST /v3/getExternalFundMove | This method is used to get the details and current status for an external fund move. |
POST /v3/getExternalFundMoveHistory | This method is used to retrieve all the external fund move details for all ACH transactions that have been processed for a particular Account (createAccount) |
POST /v3/getExternalFundMoveInfo | This method is used to get all information for an external fund move. |
POST /v3/linkExternalAccount | This method is used to add an external account using Plaid. |
POST /v3/requestForVoidACH | This method is used to update the pending ACH transaction to void. |
POST /v3/updateExternalAccount | This method is used to update fields related to a particular external account for an Account (createAccount). |
POST /v3/updateLinkExternalAccount | This method is used to update an external account using Plaid. |
POST /v3/validateABARoutingNumber | This method is used to validate the routing number for an external account (createExternalAccount) |
Credit Card Transactions¶
| Endpoint | Description |
|---|---|
POST /v3/ccFundMove | This method is used to perform an online credit card transaction. |
POST /v3/ccFundMovement | This method is used to perform an online credit card transaction. |
POST /v3/deleteCreditCard | This method is used to delete a credit card that is saved to an account. |
POST /v3/getCCFundMoveHistory | This method is used to retrieve the information for all credit card transactions that have been created for a specific account. |
POST /v3/getCCFundMoveInfo | This method is used to get all information for a specific 'ccfundmove'. |
POST /v3/getLinkedCreditCard | Use this API to get the credit card information through TransactAPI's integration with Stripe. |
POST /v3/linkCreditCard | Use this API to add credit card information through TransactAPI's integration with Stripe Payment Processing. |
POST /v3/requestForVoidCCTransaction | This method is used to update the pending Credit Card transaction to void. |
POST /v3/updateCreditCard | This endpoint no longer updates credit card information. |
POST /v3/updateLinkedCreditCard | This method returns a URL for the hosted form where an investor updates the credit card linked to an account (linkCreditCard). |
Custodial Accounts¶
| Endpoint | Description |
|---|---|
POST /v3/createCustodyAccountRequest | This method is used to request a custodial account. |
POST /v3/createCustodyAccountSupplement | This method is used to request a custodial account. |
POST /v3/createCustodyAgreementAttestation | This method is used to record when a party attests to North Capital account terms and conditions. |
POST /v3/createCustodyFundDisbursement | This method requests a disbursement (withdrawal) of funds from a custody account. |
POST /v3/createCustodyFundMove | This method initiates a fund move (deposit) into a custody account by debiting the external bank account linked to the supplied TAPI account. |
POST /v3/createCustodyPartySupplement | This method is used to add additional fields that may be required in order to open a custodial account through North Capital Private Securities. |
GET /v3/custody/accounts/{id}/positions | Fetch the security positions held in a single custody account. |
GET /v3/custody/accounts/{id}/statements | Fetch the statements and tax documents generated for the specified custody account. |
GET /v3/custody/accounts/{id}/transactions | Fetch a list of custodian ledger transactions for the specified custody account. |
GET /v3/custody/accounts | This endpoint retrieves a paginated list of custody account records owned by the authenticated client. |
GET /v3/custody/accounts/{id} | This endpoint retrieves a single custody account record by its TAPI Account ID. |
GET /v3/custody/positions | Fetch the aggregated security positions across every custody account owned by the authenticated client. |
GET /v3/custody/distributions | This endpoint retrieves a paginated list of custody distribution records. |
GET /v3/custody/distributions/{id} | This endpoint retrieves a single custody distribution record by its distribution id. |
POST /v3/custody/distributions | Create one or more custody distributions in a single submission. |
POST /v3/deleteCustodyAccountSupplement | This method is used to delete the additional fields stored for a custodial account through createCustodyAccountSupplement. |
POST /v3/getCustodyAccountRequest | This method returns the current status of a custodial account request for the supplied TAPI account. |
POST /v3/getCustodialDocuments | This method returns the statements and tax forms generated for a North Capital Private Securities custodial account. |
POST /v3/getCustodyAccountSupplement | This method is used to retrieve the additional fields stored for a custodial account through createCustodyAccountSupplement. |
POST /v3/getCustodyBalances | This method is used to get the Cash, Securities, and Total account values of a custody account. |
POST /v3/getCustodyCashTransactions | This method returns the paginated cash transaction history (deposits, withdrawals, fees, and other cash activity) for a custody account. |
POST /v3/getCustodyFundMove | Get information about a custody fund move intent (deposit) |
POST /v3/getCustodyFundMoves | Get the list of custody fund move intents for a given custody account |
POST /v3/getCustodyFundDisbursements | This method returns a paginated list of the custody fund disbursement requests created through createCustodyFundDisbursement, including the current status of… |
POST /v3/updateCustodyAccountRequest | This method is used to update the status of an existing custody account request (createCustodyAccountRequest) when new information has been added. |
POST /v3/updateCustodyAccountSupplement | This method is used to update the additional fields stored for a custodial account through createCustodyAccountSupplement. |
POST /v3/updateCustodyFundMove | This method is used to update the pending ACH transaction to void. |
POST /v3/updateCustodyPartySupplement | This method is used to update the additional fields that may be required in order to open a custodial account through North Capital Private Securities. |
POST /v3/getCustodyPartySupplement | This method is used to retrieve the additional fields stored for a party through createCustodyPartySupplement. |
POST /v3/deleteCustodyPartySupplement | This method is used to delete the additional fields stored for a party. |
Issuers¶
| Endpoint | Description |
|---|---|
PUT /v3/createIssuer | This method is used to create an Issuer in TransactAPI. |
PUT /v3/createIssuerAccount | This method is used to create an issuer account. |
POST /v3/deleteIssuer | This method is used to delete a particular issuer from TransactAPI. |
POST /v3/deleteIssuerAccount | This method is used to delete a particular Issuer financial account from TransactAPI. |
POST /v3/getAllIssuers | Deprecated. Get all issuers for a given client |
POST /v3/getIssuer | This method is used to get information about an issuer. |
POST /v3/getIssuerAccount | This method is used to get information about the issuer account. |
GET /v3/issuers | Fetch a list of issuer resources associated with this client. |
POST /v3/searchIssuer | Deprecated. This method is used to search issuers by keyword. |
POST /v3/updateIssuer | This method is used to update a particular issuer in TransactAPI. |
POST /v3/updateIssuerAccount | This method is used to update an existing issuer account. |
Links¶
| Endpoint | Description |
|---|---|
PUT /v3/createLink | This method is used to link an account (createAccount) to a party (either individual or entity) or to another account. |
POST /v3/deleteLink | This method is used to delete a particular link between an account and a party or other account. |
POST /v3/getAllLinks | Deprecated. This endpoint has been deprecated, it is superseded by /v3/links |
POST /v3/getLink | This method is used to get information about a Link between an account and a party or other account. |
GET /v3/links | Fetch a paginated list of link resources associated with this client. |
ATS / PPEX¶
| Endpoint | Description |
|---|---|
POST /v3/cancelOrder | Cancel the order |
POST /v3/createOrder | Create the Order |
POST /v3/createSecurityMarketHours | This method sets the weekly trading hours for a security on the ATS. |
POST /v3/deleteSecurityMarketHours | This method removes the trading hours configured for a security (createSecurityMarketHours), returning it to the default market schedule. |
POST /v3/getClob | Returns the consolidated limit order book (CLOB) top-of-book for a security: the best (highest) live Bid price and the best (lowest) live Offer price. |
POST /v3/getIssuerApprovedSecurities | Returns the list of approved, active securities (offerings) for an issuer. |
POST /v3/getMarketHolidays | This method lists the dates on which the ATS is closed for trading. |
POST /v3/getMarketHours | Returns the PPEX global weekday market hours (Monday through Friday). |
POST /v3/getMatchedTrade | Returns the details of a single matched trade (the pairing of a Bid order against an Offer order) identified by its match/trade ID, including the two order I… |
POST /v3/getOrder | Each orderDetails element contains: |
POST /v3/getOrderBook | Returns the open order book for a security: every live order resting on the book (status Live or Partially Executed). |
POST /v3/getOrdersForADay | Deprecated. Use ppex/orders with a createdDate filter instead. |
POST /v3/getSecurityInformation | Returns descriptive information for an approved, active security (offering): issuer, name, ticker, CUSIP, industry, security type, and description. |
POST /v3/getSecurityMarketHours | This method retrieves the weekly trading hours configured for a security (createSecurityMarketHours). |
POST /v3/getSettlementStatus | This method retrieves the settlement status of a matched trade on the ATS. |
POST /v3/notifySettlement | This method reports the settlement outcome of a matched trade on the ATS, as Settled or Canceled. |
GET /v3/ppex/orders | Retrieves a paginated list of PPEX orders with support for filtering, sorting, and optional trade inclusion. |
GET /v3/ppex/orders/{id} | This endpoint retrieves a single PPEX order. |
GET /v3/ppex/trades | Retrieves a paginated list of PPEX trades (matched/settling executions). |
GET /v3/ppex/trades/{id} | Retrieves a single PPEX trade by its trade ID. |
POST /v3/updateSecurityMarketHours | This method updates the weekly trading hours configured for a security (createSecurityMarketHours). |
GET /v3/ppex/market/holidays | Returns market holidays within a date range from the holiday calendar. |
GET /v3/ppex/market/hours | Returns the weekly trading schedule (Monday–Sunday). |
GET /v3/ppex/market/schedule | Returns a date-by-date merged schedule combining weekly trading hours with holiday closures. |
GET /v3/ppex/market/status | Returns whether the PPEX market is currently open or closed, including the reason for closure. |
Health Check¶
| Endpoint | Description |
|---|---|
GET /v3/ping | Confirms the API is reachable and your credentials are valid. |
GET /v3/status | Returns the server time, deployed version, and environment name. |
Deprecated¶
These endpoints still respond but should not be used in new integrations.
Deprecated Endpoints¶
| Endpoint | Description |
|---|---|
POST /v3/addCreditCard | Deprecated. Use POST /v3/linkCreditCard instead. |
POST /v3/addCustodyAccountSupplement | Deprecated. This method is used to request a custodial account. |
POST /v3/addCustodyPartySupplement | Deprecated. This method is used to add additional fields that may be required in order to open a custodial account through North Capital Private Securities. |
POST /v3/getCreditCard | Deprecated. Use POST /v3/getLinkedCreditCard instead. |
POST /recordAttestation | Removed. This endpoint has been removed and can no longer be called. |
POST /v3/requestCustodialAccount | Deprecated. This is a deprecated function. |
POST /v3/updateCustodialAccountRequest | Deprecated. This method has been deprecated. |
Serverless APIs¶
| Endpoint | Description |
|---|---|
POST /getLinkedAccounts | Retired. This API showed all accounts that are linked to the party id. |
POST /getAccount | Retired. The securityid-based lookup documented below does not exist on the v3 API. |
POST /getTradeStatusesForOffering | Retired. Returned an array of trade IDs and current trade statuses associated with a specific Offering ID. |
POST /getApiCount | Retired. This method will provide the API count for the current month (midnight UTC on the 1st to current day) |