Prefill

Retrieve the field schema of a document. Each field is what you specify in the prefill blob you upload to storage: a blob entry is { id, value }, where id is this field's id and value is the value to prefill. When options is set, value must be one of them; otherwise value is a string (text or checkbox value) or a data URL (signature, picture). Returns 409 when the document has no configured fields. Configure fields via the dashboard first.

get/documents/{document_id}/fields

Request

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

Path parameters

document_idstring uuid required

Response

Successful response

Example response

{
  "data": [
    {
      "id": "f_abc",
      "name": "last_name",
      "type": "text",
      "page": 1,
      "options": null,
      "default_value": false,
      "required": true,
      "read_only": false
    },
    {
      "id": "f_ghi",
      "name": "newsletter_opt_in",
      "type": "checkbox",
      "page": 2,
      "options": [
        "checked",
        "xchecked",
        "unchecked"
      ],
      "default_value": false,
      "required": false,
      "read_only": false
    },
    {
      "id": "f_jkl",
      "name": "country",
      "type": "dropdown",
      "page": 2,
      "options": [
        "US",
        "CA",
        "GB"
      ],
      "default_value": false,
      "required": true,
      "read_only": false
    },
    {
      "id": "f_mno",
      "name": "plan",
      "type": "radio",
      "page": 2,
      "options": [
        "basic",
        "pro",
        "enterprise"
      ],
      "default_value": false,
      "required": true,
      "read_only": false
    },
    {
      "id": "f_pqr",
      "name": "profile_photo",
      "type": "picture",
      "page": 3,
      "options": null,
      "default_value": false,
      "required": false,
      "read_only": false
    },
    {
      "id": "f_stu",
      "name": "signature",
      "type": "signature",
      "page": 5,
      "options": null,
      "default_value": false,
      "required": true,
      "read_only": false
    },
    {
      "id": "f_vwx",
      "name": "form_number",
      "type": "text",
      "page": 1,
      "options": null,
      "default_value": true,
      "required": false,
      "read_only": true
    }
  ]
}

Changes

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