Skip to navigation
Paperwork APITemplates

Add a template by URL, or get a presigned upload URL

View as Markdown

Adds a blank form to your organization’s template library.

The two request shapes match POST /v1/files:

  • { url, name? } — fetched over http(s) for you.
  • { name, mimeType } — returns uploadUrl plus uploadExpiresAt (15 minutes); PUT the bytes with a Content-Type equal to the mimeType you sent.
{ "url": "https://www.irs.gov/pub/irs-pdf/fw9.pdf", "name": "w9.pdf" }

Templates are deliberately never parsed or indexed — they are documents to be filled, not read. That is why a template reaches ready as soon as its bytes land, with no processing stage. Pass one to fill as template: { "id": "…" }.

Learn more: Form filling guide

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
objectRequired
OR
objectRequired

Response

The template.
object"template"
idstring
namestring
mimeTypestring
statusenum
Allowed values:
createdAtstring
kindstringOptional
downloadUrlstringOptional
uploadUrlstringOptional
uploadExpiresAtstringOptional

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error