Download

Returns a file stored on the fintechOS platform encoded using the Base46 scheme. You can use this in conjunction with the Upload API endpoint to transfer files between FintechOS platform servers.

Syntax

Copy 
POST <host_address>/api/openApiV2/Download
            
Content-Type: application/json
AccessToken: <access_token>
            
{
    <file_id>
}
 
Parameter Description
host_address URL of the FintechOS platform server.
access_token Access token used to connect to the API endpoint. For details, see Authentication.
file_id Unique ID of the file to be downloaded from the FintechOS server.

Response

If the download is successful, the file content encoded using the Base64 scheme is returned.

Examples

In this example:

  • A user downloads a scanned contract file from the https://FintechOSStudio server.
  • The user is identified by the 78596ed1-df3a-4ce0-b49a-60f4aabd0ebe access token (for information on how to obtain the access token, see Authentication).
  • The scan is stored in a file identified by the contract_2eebb11c-528e-4816-88fc-97cce3d5a798.jpg ID on the FintechOS server.
  • The file content is returned encoded in the Base64 scheme.

Request

Copy 
POST https://FintechOSStudio/api/openApiV2/Download

Content-Type: application/json
AccessToken: <access_token>

{
    "contract_2eebb11c-528e-4816-88fc-97cce3d5a798.jpg"
}

Response

Copy 
"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABF .......................... CAgICI+IDxyZGY6U"