post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/addSubscriptionsforOffering
This method is used to add Subscription Documents to the offering through DocuSign. A template can be set up in DocuSign, allowing investor data to be auto-populated when the documents are sent. The Offering ID is required to add a Template Document. This method will return the Template ID as a successful response. To obtain the templateId needed for the templatename param, fetchSubscriptionDocuments can be used. A DocuSign business account connected to TransactAPI is required to use this method.
Request Parameters
Parameter | Required | Type | Description |
---|---|---|---|
clientID | yes | string | TransactAPI Client ID |
developerAPIKey | yes | string | TransactAPI Developer Key |
templatename | yes | string | The name of the template as it is titled in Docusign |
offeringId | yes | string | Offering ID that is generated by the API once an offering is created(createOffering) for the offering that the subscription document template is to be added |
file_name | no | string | File name of the uploaded document. No special characters can be included in the file name |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/addSubscriptionsforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d templatename0=XEXZP636F3A3A36--Alpha
-d offeringId=55593
Response Parameters
Parameter | Type | Description |
---|---|---|
statusCode | string | API Status Code |
statusDesc | string | API Status Description |
documentDetails | string | Returns the template details as an array |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": [
{
"templateNameID": "55591",
"templateName": "ABC Company",
"offeringId": "55591"
}
]
}