unforged/folio · docs · Share
Exports, reports and links
Sooner or later someone outside your team will need a record, whether that’s a client, an auditor or the other side’s solicitor, and each way of getting it to them will show in your ledger.
Exports
A records export will bundle each document with its receipt, its details, a list of fingerprints for the whole bundle and, if you’re allowed to read the ledger, its history. You’ll be able to export a list of records, a folder, a matter or everything about one person, up to 512 MB of documents at a time.
Exporting documents counts as viewing them, so it will need a reason wherever opening them would. We’ll build the export in the background and send folio.export.ready to your webhook when it’s done, and only the person who asked will be able to download it.
Reports for your auditor
A custody report will list everything that has happened to one record since it was filed, in order, with who did it, when and why, and a fresh integrity check.
An integrity check will read the stored file again and compare it with the fingerprint on its receipt. A clean result will mean the bytes are the ones you filed; it won’t say whether the document itself is genuine, which is a different question.
You’ll also be able to export the ledger itself as a report.
Sharing one record by link
For a person or a tool that can’t use an API key, you’ll be able to make a download link for one record that lasts up to 15 minutes. Making it will count as viewing the record, and every download through it will be recorded in your ledger as a view by you.
The link will be shown once, so send it straight on.
The routes
- POST
/folio/exports - GET
/folio/exports/{id} - GET
/folio/exports/{id}/download - GET
/folio/records/{id}/custody - GET
/folio/records/{id}/integrity - POST
/folio/records/{id}/link - GET
/folio/links/{token}