API ReferenceFiles

Get File

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

file_idstringRequiredformat: "uuid"

Query parameters

account_idstringRequired
id_typeenum or nullOptional
Type of the account id. Must be 'institution' or 'None'.
Allowed values:
response_typeenumOptional

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.

Allowed values:

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error