The Send Subscription Document endpoint initiates the initial delivery of subscription documents to investors for a specific trade.
Overview
The Send Subscription Document endpoint initiates the initial delivery of subscription documents to investors for a specific trade. This API creates new document envelopes using DocuSign integration, populating templates with comprehensive investor data including account details, party information, banking details, and regulatory compliance fields. The endpoint validates all required parameters (offeringId, accountId, tradeId), ensures proper account relationships exist, and verifies that subscription documents are configured for the offering. Once validated, it generates new document keys, sends the documents to the primary party's email address, and updates the investment records with the document status set to 'NOTSIGNED'. For scenarios where documents need to be sent again after initial delivery, use the complementary Resend Subscription Documents endpoint instead.
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| offeringId | yes | integer | Offering ID that is generated by the API when an offering is created (createOffering) |
| accountId | yes | string | Account ID that is generated by the API when an account is created (createAccount) |
| tradeId | yes | string | Trade ID that is generated by the API when an trade is created (createTrade) |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/sendSubscriptionDocument
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=273410
-d accountId=A12345
-d tradeId=123456789
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| document_details | string | Document details of the matched Party (documentKey, esignStatus, partyId) |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": "Subscription Document Sent Successfully"
}