Documents

File a document from a link

Downloads the file a link points at and files it as a document of the given kind, under every record in links. The way to file a file you hold only as a link, since the bytes cannot travel in a JSON call. The link has to be https, answer within 30 seconds and hold one file the filing takes, a photo, PDF or office document of 33554432 bytes or less. A link that needs a sign-in, a web page, an address rather than a host name, or more than 5 redirects is refused. The link itself is not kept, only its host.

post/api/v1/documents/from-url

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/documents/from-url
  • Auth: API key in cookie better-auth.session_token

Request body

urlstring uri required

An https link that downloads the file itself: a public or signed link, such as a presigned S3 URL or a Dropbox link ending dl=1. A link behind a sign-in, such as a private Google Drive file, cannot be read.

kind'lease' | 'lease_annex' | 'inspection_report' | 'invoice' | 'receipt' | 'quote' | 'supplier_invoice' | 'certificate' | 'id_document' | 'proof_of_income' | 'insurance_policy' | 'deed' | 'floor_plan' | 'photo' | 'correspondence' | 'formal_notice' | 'statement' | 'tax_document' | 'lease_termination' | 'lease_amendment' | 'other' required

What the document is.

namestring

What to call it in the filing. The file’s own name when left out.

Response

The document it is now filed as.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.