uploadEntityDocument

This method is used to upload a document to a particular entity party (createEntity). The Party ID is required as a request parameter for this method. Files cannot be larger than 100 MB.

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
partyIdyesstringEntity Party ID that is generated by the API when an entity party is created(createEntity)
documentTitleyesstringUploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field
file_nameyesstringUploaded document file name. Please use prefix "filename0=" in the value of file_name field
userfile0yesstringPDF, jpg, and png files are supported. While uploading the files, please provide a temporary file name. Prefix @ on the file name. Eg : @/tmp/phpAHi2ZC Request parameter should be userfile0 for documents upload. Please Refer to Sample Request set below.
createdIpAddressyesstringRequested IP Address

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/uploadEntityDocument
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d partyId=E17080
-d documentTitle=test
-d file_name=Uploaded file name
-d [email protected]/tmp/phpAHi2ZC
-d createdIpAddress=10.0.0.9

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
document_detailsstringDocument has been uploaded successfully

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "document_details": "Document has been uploaded Successfully"
}

Test it Yourself!

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