Use this endpoint to upload a document onto the Finmo ecosystem. Upon successful upload, a document ID and other relevant details are returned in the response. This document ID can then be used in subsequent API calls, such as customer creation, payout invoice, payin file upload etc. This guide provides a detailed walk-through of the upload process.
File upload via API now follows a two-step process. Below is Process Overview:
1. Requesting Upload URL:
This step generates an Upload URL for file submission. The request should specify a doc_type and a file_type. You must store the org_document_id parameter from the response in your system for future reference.
2. Uploading File to the Upload URL:
Use the upload_url obtained in the previous step to upload the file using the PUT method.
Eg: PUT/upload_url, will upload the required file in our system
Note:
- Store org_document_id from the response for further use to submit the document & to fetch the document which depends in is_downloadable flag
- URL validity: upload_url, download_url is valid for 30 seconds. If it expires, you must request a new link.
There are several valid doc_type values, each with file format and size requirements.
| Doc Type | Description | File Type | Max Size | Is Downloadable |
|---|---|---|---|---|
| CUSTOMER_DOCUMENT | Documents required to create Customer, such as identity proof or address verification | image/png, image/jpeg, image/jpg, application/pdf | 5MB | True |