post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/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
Parameter | Required | Type | Description |
---|---|---|---|
clientID | yes | string | TransactAPI Client ID |
developerAPIKey | yes | string | TransactAPI Developer Key |
partyId | yes | string | Party ID that is generated by the API when a party is created (createParty) |
documentTitle | yes | string | Uploaded document title. Please use prefix "documentTitle0=" in the value of documentTitle field |
file_name | yes | string | Uploaded document file name. Please use prefix "filename0=" in the value of file_name field |
userfile0 | yes | string | PDF, .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. |
createdIpAddress | yes | string | Requested 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
Parameter | Type | Description |
---|---|---|
statusCode | string | API Status Code |
statusDesc | string | API Status Description |
document_details | string | Document has been uploaded |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": "Document has been uploaded Successfully"
}