This method is used to add a document to an offering. Only .pdf and .xls files can de uploaded. Only PDF files are able to be watermarked. 50 MB max file upload.

Request Parameters

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
offeringIdyesintegerOffering ID that is generated by the API once an offering is created (createOffering)
documentTitleyesstringTitle/label for the uploaded document
documentFileReferenceCodeyesstringReference code for the uploaded document (can be any number to use for tracking)
file_nameyesstringFile name of the uploaded document. No special characters can be included in the file name.
userfile0yesstringWhile 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
templateNamenoconditionalOffering Document Template Name (can be used if using certain templates for tracking)
approvalnostringHas the Document been approved by a Registered Principal? Yes or No
supervisornamenostringName of the Approving Principal
datenointegerDate that the Document was Approved
createdIpAddressnostringIP Address of the addDocumentsforOffering method call

Sample Request

curl --location '' \
--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=""'

curl -k -X POST
--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=

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
offeringIdintegerOffering ID generated by the API
documentIdstringDocument ID generated by the API
documentURLstringUploaded document URL

Sample Response

  statusCode: "101",
  statusDesc: "Ok",
  document_details: [
      offeringId: "7671",
      documentId: "21344",
      documentReferenceCode: "24102016121212",
      documentURL: ""
      offeringId: "7671",
      documentId: "52348",
      documentReferenceCode: "24102016121212",
      documentURL: ""

Test it Yourself!

Click Try It! to start a request and see the response here!