You can now use this generic endpoint to upload documents to the Finmo ecosystem for a variety of workflows. Upon successful upload, the API returns a unique document ID along with other relevant metadata. This document ID can be referenced in subsequent API calls across different modules.

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 from the previous step to upload the file via a PUT request. Example: PUT /upload_url uploads the file to the system.

Set the header based on the type of file you are sending: --header 'Content-Type: <file_type>'

Note:

1. Store org_document_id from the response for further use to submit the document & to fetch the document which depends in is_downloadable flag
2. 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": "CUSTOMER_DOCUMENT",
  "file_name": "passport",
  "file_type": "image/png",
  "descriptor": "identification_document"
}