document

Ask for files on an upload page

Use this when the person has a file you can't pass yourself, or it's over 2 MB. Returns upload_url, a page where the person drops PDFs, and put_url, which takes one PDF as the request body for clients that make HTTP requests. Both work once, for 30 minutes. Each file becomes a document; find it with document_list or activity_list. With purpose "safe_import", for SAFEs signed elsewhere and their DocuSign certificates: after the drop the person checks what Binderwork read and imports them at review_url, and each then waits Unconfirmed in the register (captable_get with include register) for an officer. With purpose "captable_import", for a cap table export (Pulley's files, Carta's reports, an OCF package or a spreadsheet, with the agreements as PDFs): the spreadsheets, ZIPs and JSON files are kept in the archive, the PDFs become documents, and captable_prepare imports them with import.upload_id. With document_id, the one PDF dropped becomes that document's next version, under every link it has.

post/uploads

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/uploads
  • Auth: HTTP bearer

Request body

purpose'documents' | 'safe_import' | 'captable_import'

documents; safe_import for signed SAFEs; captable_import for a cap table.

document_idstring

Makes the drop this document's new version.

Response

The result.

upload_idstring required
purpose'documents' | 'safe_import' | 'captable_import' required
upload_urlstring required
put_urlstring required
review_urlstring nullable required
expires_atstring date-time required

Changes

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