MOmodernfi
Files

Get File

Changed on
get/digital-banking/v1/files/{file_id}

Request

Path parameters

file_idstring uuid required

Query parameters

string uuid
OR
string
institution_idstring uuid nullable

Your institution's ModernFi ID; allows institution statements only. Provide exactly one of account_id or institution_id.

id_type'INSTITUTION'

Type of the account id. Institution accounts ids are external ids and come from the institution.

Set to INSTITUTION when account_id is your bank's own account number (the sweep or return account number) instead of the ModernFi account ID. It never accepts an institution ID; to get institution statements, pass institution_id instead.

response_type'presigned_url' | 'file'

Form of the response. 'presigned_url' (default) returns a JSON object with a short-lived presigned download URL. 'file' streams the file back directly as raw bytes (Content-Type derived from the file, e.g. application/pdf or text/csv), for callers that cannot fetch presigned URLs.

Response

When response_type=file, the file is streamed back directly as raw bytes, with a Content-Type derived from the file (e.g. application/pdf or text/csv). Otherwise a JSON object containing a presigned_url is returned.

presigned_urlstring required

Changes

  • 3e016a6fb6d7Revision changes
    • info

      added the new optional query request parameter institution_id

    • info

      the query request parameter account_id became optional

    • info

      query request parameter account_id list-of-types was widened by adding types null