Upload Document to Application
Upload a document to the application.
Wait for the response for an upload request before initiating the next upload request. Do not execute multiple threads concurrently.
app_token
The identifier of the application.
section
The section of the application. For example
company.
image parameter name
Use the
--formparameter to define the path to the document file on your local machine. Enter the name of the image parameter folllowed by its path. For example, for theaddress_refimage parameter where the file is located at C:/path/to/file/address.png, enter:--form 'address_ref=@"C:/path/to/file/address.png"'Format Supported file types include '*.pdf', '*.doc', '*.docx', '.*csv', '*.jpeg', '*.jpg', '*.gif', '*.png'. Format of input must follow the
multipart/form-dataprotocol. Use thefilesparameter to upload multiple files.Note
* Maximum number of files that can be uploaded in one request is 10.
Note
* Maximum size of files that can be uploaded in one request is 20 MB.
Note
* Document file name should be up to 200 characters long.
Note
Uploading multiple files can return a Pending Review status for the files that were uploaded successfully and a Not Valid status for the file that was not uploaded due to an error such as an invalid file name. See also the sample on reponse this page.
The following parameters are returned for each uploaded file:
file_name
The name of the uploaded file.
upload_status
Status of the uploaded document. Values include
Pending Review,Not Valid,Accepted, andRejected.
token
The identifier of the uploaded file.
error
The error that occurred during the upload. Value is
nullwhen upload is successful.
field
The field name in the section of the application that the image is linked to.
{base_uri}/v1/partner/onboarding/application/documents/:app_token/:section/
Upload Document to Application
curl -X POST {base_uri}/v1/partner/onboarding/application/documents/app_token_348930548035830/company/ -H 'access_key: your-access-key-here' -H 'Content-Type: multipart/form-data' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -H 'api_timestamp: your-unix-timestamp-here' --form 'company_documents=@"/Users/John/Documents/2.png"' \{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "0bf00a37-d4a8-47ff-a7da-4ee70db57bbb" }, "data": { "file_name": "Screenshot 2025-04-28 at 15.28.57.png", "upload_status": "Pending Review", "token": "file_6bd792ef69804e2a99895405531b6930", "error": null, "field": "company_documents" } }
Upload Multiple Documents to Application with one error for invalid field
curl -X POST {base_uri}/v1/partner/onboarding/application/documents/app_dcfa6baf03574867a439aca0c3eda671/owner' -H 'access_key: your-access-key-here' -H 'Content-Type: multipart/form-data' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -H 'api_timestamp: your-unix-timestamp-here' --form 'addres=@"/Users/Jane/Automation/scans/sample_pdf.pdf"' \ --form 'id_img=@"/Users/Jane/Downloads/image1.png"'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "896a04e0-821c-4ed0-b81e-39c663830645" }, "data": [ { "file_name": "sample_pdf.pdf", "upload_status": "Not Valid", "token": null, "error": "ERROR_INVALID_SECTION_OR_FIELD_FOR_UPLOADED_DOCUMENT", "message": "The request attempted to upload a document, but the specified section and/or field for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid file and section.", "field": "addres" }, { "file_name": "image1.png", "upload_status": "Pending Review", "token": "file_054e4e1e7323497787b34d13f62df7be", "error": null, "message": null, "field": "id_img" } ] }
Upload Multiple Documents to Application with error for invalid fields
curl -X POST {base_uri}/v1/partner/onboarding/application/documents/app_dcfa6baf03574867a439aca0c3eda671/owner' -H 'access_key: your-access-key-here' -H 'Content-Type: multipart/form-data' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -H 'api_timestamp: your-unix-timestamp-here' --form 'addres=@"/Users/Jane/Automation/scans/sample_pdf.pdf"' \ --form 'id=@"/Users/Jane/Downloads/image1.png"'{ "status": { "error_code": "ERROR_INVALID_SECTION_OR_FIELD_FOR_UPLOADED_DOCUMENT", "status": "ERROR", "message": "Error for each file in this request: The request attempted to upload a document, but the specified section and/or field for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid file and section.", "response_code": "ERROR_INVALID_SECTION_OR_FIELD_FOR_UPLOADED_DOCUMENT", "operation_id": "d6e7735c-e4aa-48e5-9259-a19dfeef285b" } }
File upload to Application with error for invalid section
curl -X POST {base_uri}/v1/partner/onboarding/application/documents/app_dcfa6baf03574867a439aca0c3eda671/own' -H 'access_key: your-access-key-here' -H 'Content-Type: multipart/form-data' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -H 'api_timestamp: your-unix-timestamp-here' --form 'address_ref=@"/Users/Jane/Automation/scans/sample_pdf.pdf"' \ --form 'id_img=@"/Users/Jane/Downloads/image1.png"'{ "status": { "error_code": "ERROR_INVALID_SECTION_FOR_UPLOADED_DOCUMENT", "status": "ERROR", "message": "The request attempted to upload a document, but the specified section for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid section.", "response_code": "ERROR_INVALID_SECTION_FOR_UPLOADED_DOCUMENT", "operation_id": "42c8503d-a177-46a7-8dbe-56150abe2169" } }