API Reference

Download a signed document

get
https://secure.finch-app.com/api/public/v1/file//document//download

Downloads a signed document with the given ID from a given file.

Permissions

The following permissions are required to call this API. Learn more.

Permission typePermissions
API key action permissionFile
Folder access control list permissionViewer

Remarks

Signed documents in Finch need to be executed before they are binding. Users should generally check the document status before downloading a document.
In addition, users should also check they are using the latest/most-current copy of a document by checking the "current" flag on the document.

File name is included in the content-disposition header.

Path Params
string | null
required
string | null
required
Query Params
sections
array of strings | null

Specify the named sections of a document provide only those sections within the download. The document is reorganised into the order of the section names you provide.

sections
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
application/json

Updated over 2 years ago