Prefill

Retrieve a specific prefill, including a short-lived presigned GET URL to its blob in your storage.

get/documents/{document_id}/prefills/{prefill_id}

Request

  • Base URL: https://api-docs.simplepdf.com/api/v1
  • URL: https://api-docs.simplepdf.com/api/v1/documents/{document_id}/prefills/{prefill_id}
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required
prefill_idstring uuid required

Response

Successful response

idstring required
created_atstring required
contextunknown required
embed_urlstring required

Link a recipient opens to review and submit the prefilled document (standalone or embedded).

urlstring required

Short-lived presigned GET URL to the prefill blob in customer storage.

Example response

{
  "id": "05666d45-96d0-42ce-b24b-f1f1af228f57",
  "created_at": "2026-03-21T10:00:00.000Z",
  "context": {
    "agent": "intake-bot",
    "user_id": "u_123",
    "environment": "production"
  },
  "embed_url": "https://api-docs.simplepdf.com/documents/05666d45-96d0-42ce-b24b-f1f1af228f57?prefill=...",
  "url": "https://customer-bucket.s3.amazonaws.com/prefills/...?X-Amz-..."
}

Changes

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