Read field values from an envelope

You can now read what signers type into an envelope. Fetch field values returns every field with its value, the recipient who owns it, and any value that was pre-filled into it. It answers at every status, from the moment you send the envelope to after it's signed.

curl https://api.signeasy.com/v3/rs/envelope/200000001/fields \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "field_id": "6f1c0c1e-1a2b-4c3d-8e9f-000000000004",
  "label": "Company size",
  "type": "text",
  "state": "filled",
  "value": "11-50",
  "prefill": [
    { "value": "1-10", "prefilled_by": { "type": "sender" } },
    { "value": "11-50", "prefilled_by": { "type": "recipient", "recipient_id": 300000001 } }
  ],
  "recipient_id": 300000002,
  "source_id": 400001,
  "page_number": 1,
  "required": true,
  "options": null,
  "additional_info": null,
  "position": { "mode": "fixed", "x": 240, "y": 556, "width": 160, "height": 20 }
}

• Every value is a string or null. A checkbox is "true" or "false", a signature is "applied", and a date comes back as the signer saw it, with its format in additional_info.format.
• state is pending until the field's recipient finishes, then filled, or skipped for an optional field left empty.
• prefill lists the values the sender or an earlier signer put in the field, oldest first. Compare the last one with value to see what the signer changed.
• Filter with recipient_id and types.
• Webhooks don't carry the values. Call the endpoint when rs.signed or rs.completed arrives.

Once an envelope is complete, Fetch field values of a signed envelope returns the same response from the signed path.

🚧

Known issues

Fields that belong to a recipient group come back once for every member, and the copies of members who didn't sign stay pending even after the envelope is complete. radio_positions can come back in a different order from the one you sent on create. The signed path returns 400 until the envelope is complete. Fixes are planned. The reference page has the workarounds.

Reading field values is available on the API Advanced Plan.