The short answer: When you retrieve a completed transaction or document through the Proof API, each field on the document now includes the value the signer entered. You can pull that data straight into your own systems instead of reading it out of the completed PDF.
What You Get
| Detail | What it tells you |
|---|---|
| Type | What kind of field it is, such as a text, date, or signature field. |
| Signer | Which signer the field belongs to. If you set an external ID for the signer, it's included so you can match it to your own records. |
| Position and size | Where the field sits on the page and how big it is. |
| Fulfilled | Whether the field was filled in. |
| Value | What the signer entered. It's included for completed documents. Signature fields don't include a value. |
How to Retrieve Field Values
Complete the transaction
Field values are available once the document has been completed.
Retrieve the transaction or document through the API
Use the Proof API to retrieve the transaction, or a single document from it. The response includes the field details for each document.
Read the value for each field
Use the signer's external ID to match each value to your own records, then pull the values into your system.
Who Can Use It
| Topic | Details |
|---|---|
| Availability | Generally available. |
| Plans | Business Pro+ and Premium/Elite. Business Pro organizations can upgrade. See Upgrade from Business Pro to Business Pro+. |
| Access | API only. You need API access to retrieve field values. See Generate a Full-Access API Key. |
| Who can use it | Owners and Admins, and the developers who work with your API access. |
If You Don't See a Field Value
- Check that the document has been completed. Values are included for completed documents.
- Signature fields never include a value.
- Check that your organization is on Business Pro+ or Premium/Elite.
If a value is still missing, submit a support request and include the transaction ID.
Summary Checklist
- Field values come back on each field when you retrieve a completed transaction or document through the API.
- Each field includes its type, signer, position and size, whether it was filled in, and the value the signer entered.
- It is available through the API only, for Business Pro+ and Premium/Elite organizations.
- Add an external ID for each signer when you create the transaction so you can match values to your own records.
- Signature fields do not include a value, and values are included only for completed documents.
Updated