Skip to Content
FlowVerifyDevelopers

Add a document to a draft envelope

Scope envelopes:write. Three ways to supply the document: multipart/form-data with a file part, JSON with a public url, or JSON with content_base64. PDF, DOC, DOCX, PPT, PPTX and RTF are accepted; non-PDF documents are converted to PDF. Password-protected or corrupt PDFs are refused (422). Up to 25 MB per file, 150 MB per envelope.

Authorization

apiKey
headerAuthorizationBearer <fv_live_… or fv_test_…>

Path Parameters

id*string
Formatuuid

Request Body

  1. body
file*file
Formatbinary
name?string

Display name

Lengthlength <= 255
order?integer
Range0 <= value

Response Body

The stored file

application/json
  1. response
success*boolean
request_id*string
Formatuuid
data?
Example Request
curl -X POST 'https://api.flowverify.co/v1/envelopes/497f6eca-6276-4993-bfeb-53cbbbba6f08/files' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",  "data": {    "object": "file",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "size": 0,    "content_type": "string",    "page_count": 0,    "order": 0,    "fields": [      {        "object": "field",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",        "recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",        "type": "signature",        "label": "string",        "page": 0,        "x": 0,        "y": 0,        "width": 0,        "height": 0,        "required": true,        "value": "string",        "is_filled": true      }    ],    "converted": true,    "warnings": [      {        "code": "string",        "message": "string",        "signature_count": 0      }    ]  }}