Upload a document and associate it with an account
Request Parameters
Parameter
Required
Type
Description
clientID
yes
string
TransactAPI Client ID
developerAPIKey
yes
string
TransactAPI Developer Key
accountId
yes
string
Account ID that is generated by the API when an account is created (createAccount)
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
Raw file data. Specification of raw file data is application specific. Accepted file types are PDF, JPG, PNG, HEIC and BMP. Minimum file size is 1 kB. Maximum file size is 100 MB. Please refer to the Sample Requests section for reference implementations.
createdIpAddress
no
string
Requested IP Address
Requirements
File size: Files must be at least 1 kB and cannot exceed 100 MB.
Accepted Formats: pdf, jpg, jpeg, and png.
Content Type: The request must use multipart/form-data for proper file handling.
Multiple Files:documentTitle, userfileand filename are indexed parameters. You may provide multiple userfile parameters (e.g. userfile0, userfile1, userfile2, ...). Each userfile parameter must be accompanied by a corresponding documentTitle and filename. These should be separated by an & character. (e.g. (cURL) --form 'documentTitle="documentTitle0=DOC_TITLE_0&documentTitle1=DOC_TITLE_1"')
A valid account ID is required; use the createAccount endpoint if the account does not exist.