post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/addDocumentsforOffering
This method is used to add a document to an offering. Only .pdf, .xls, and .docx files can be uploaded. Only PDF files are able to be watermarked. 50 MB max file upload.
Log in to see full request history
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 once an offering is created (createOffering) |
| documentTitle | yes | string | Title/label for the uploaded document |
| documentFileReferenceCode | yes | string | Reference code for the uploaded document (can be any number to use for tracking) |
| file_name | yes | string | File name of the uploaded document. No special characters can be included in the file name. |
| userfile0 | yes | string | While uploading the PDF files, please provide a temporary file name. Prefix @ on the file name. Eg : @/tmp/phpAHi2ZC Request parameter should be userfile0, userfile1, userfile2,...userfilen for multiple documents upload. Refer Sample Request set below |
| templateName | no | conditional | Offering Document Template Name (can be used if using certain templates for tracking) |
| approval | no | string | Has the Document been approved by a Registered Principal? Yes or No |
| supervisorname | no | string | Name of the Approving Principal |
| date | no | integer | Date that the Document was Approved |
| createdIpAddress | no | string | IP Address of the addDocumentsforOffering method call |
Sample Request
SINGLE UPLOAD
--------------------------------------
curl --location 'https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/addDocumentsforOffering' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'clientID="ClientID"' \
--form 'developerAPIKey="DeveloperAPIKey"' \
--form 'offeringId="1338707"' \
--form 'documentTitle="documentTitle0= LaurenTest"' \
--form 'documentFileReferenceCode="220323024315"' \
--form 'file_name="filename0= Test.pdf"' \
--form 'userfile0=@"/Users/laurencoalmer/Documents/Test.pdf"' \
--form 'approval="yes"' \
--form 'supervisorname="Lauren"' \
--form 'date="02-04-2016"' \
--form 'createdIpAddress="10.0.0.9"'
MULTIPLE UPLOAD
--------------------------------------
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/addDocumentsforOffering
--f developerAPIKey=somedeveloperkey
--f clientID=someclientid
--f offeringId=55593
--f documentTitle=documentTitle0=Tagme&documentTitle1=Tested
--f documentFileReferenceCode=ReferenceCode
--f file_name=filename0=page2.pdf&filename1=page3.pdf
--f userfile0=@/tmp/phpAHi2ZC
--f userfile1=@/tmp/phpDSGTUT
--f templateName=sample document
--f approval=yes
--f supervisorname=peter
--f date=02-04-2016
--f createdIpAddress=10.0.0.9
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| offeringId | integer | Offering ID generated by the API |
| documentId | string | Document ID generated by the API |
| documentURL | string | Uploaded document URL |
Sample Response
{
statusCode: "101",
statusDesc: "Ok",
document_details: [
{
offeringId: "7671",
documentId: "21344",
documentReferenceCode: "24102016121212",
documentURL: "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ241016060807.pdf"
},
{
offeringId: "7671",
documentId: "52348",
documentReferenceCode: "24102016121212",
documentURL: "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ2410160608071.pdf"
}
]
}