updateDocumentforOffering

POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateDocumentforOffering

This method is used to update a document with a new document for an offering. The existing document will be replaced with the new document.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
documentId	yes	integer	Document ID that is generated by the API when an offering document is added (addDocumentsforOffering) of the document that is to be updated.
documentTitle	yes	string	The new Title/label for the uploaded document
documentFileReferenceCode	yes	string	The new reference code for the uploaded document (can be any number to use for tracking)
file_name	yes	string	The new file name of the uploaded document
updatedIpAddress	no	string	IP Address of the updateDocumentforOffering method call

Sample Request

cURL

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateDocumentforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d documentId=55593
-d documentTitle=Tagme
-d documentFileReferenceCode=ReferenceCode
-d file_name=mypdf_new.pdf
-d updatedIpAddress=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	integer	Document ID generated by the API
documentURL	string	Uploaded document URL

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document details": [
    {
      "offeringId": "55591",
      "documentId": "62801",
      "documentURL": "https://api-sandboxdash.norcapsecurities.com/stamp/PDF/page27.pdf"
    }
  ]
}

Test it Yourself!