Add Subscriptions for Offering Widget

"***This method is only used for clients that are using the Direct Invest Button (Widget)*** This method is used to add a document for a particular offering widget. We need to specify the offeringID and only PDF documents can be uploaded."

Request Method : POST

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
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.
documentTitle yes string Uploaded document title
file_name yes string Uploaded PDF filename
userfile0 yes string While uploading the PDF files, please provide a temporary filename. Prefix @ on the file name. Eg : @/tmp/phpAHi2ZC Request parameter should be userfile0, userfile1, userfile2,...userfilen for multiple documents upload. Please refer to the Sample Request set below.
userfile1 no string Second uploaded PDF temporary filename. Please add @ before temporary filename
createdIpAddress no string Second uploaded PDF temporary filename. Please add @ before temporary filename

Sample Request

SINGLE UPLOAD
-------------------
curl -k -X POST https://api.norcapsecurities.com/tapiv3/index.php/v3/addSubscriptionsforOfferingWidget
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55593
-d documentTitle=documentTitle0=Tagme
-d file_name=filename0=page2.pdf
-d userfile0=@/tmp/phpAHi2ZC
-d createdIpAddress=10.0.0.222


MULTIPLE UPLOAD
-------------------
curl -k -X POST https://api.norcapsecurities.com/tapiv3/index.php/v3/addSubscriptionsforOfferingWidget
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55593
-d documentTitle=documentTitle0=Tagme&documentTitle1=Tested
-d file_name=filename0=page2.pdf&filename1=page3.pdf
-d userfile0=@/tmp/phpAHi2ZC
-d userfile1=@/tmp/phpDSGTUT
-d createdIpAddress=10.0.0.222

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
offeringId string Offering ID generated by the API
documentId string Document ID generated by the API
documentURL string Uploaded document URL

Sample Response

SINGLE UPLOAD
-------------------
{
    "statusCode": "101",
    "statusDesc": "Ok",
    "document_details": [
        {
            "offeringId": "55593",
            "documentId": "13246"
        }
    ]
}



MULTIPLE UPLOAD
-------------------
{
    "statusCode": "101",
    "statusDesc": "Ok",
    "document_details": [
        {
            "offeringId": "55593",
            "documentId": "42404"
        },
        {
            "offeringId": "55593",
            "documentId": "97234"
        }
       
    ]
}
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Custodial Account