uploadPartyDocument

This method is used to upload a document to a particular individual party (createParty). 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
partyIdyesstringParty ID that is generated by the API when a party is created (createParty)
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, .png, .HEIC and .BMP 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 --location --request POST 'https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/uploadPartyDocument' 
--form 'clientID=someclientid'
--form 'partyId=somepartyid'
--form 'createdIpAddress="42.106.177.219"' 
--form 'file_name="filename0=Testing Document Size12.pdf"' 
--form 'userfile0=@"/path/to/file"' 
--form 'documentTitle="documentTitle0= Testing Document Size12.pdf"' 
--form 'developerAPIKey=somedeveloperAPIkey'

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
document_detailsstringDocument has been uploaded

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!