Fetch field values of a signed envelope

šŸ“˜

Advanced Plan

Field data extraction is available only on the API Advanced Plan.

Get the field values of a completed envelope. Once every recipient has signed, this returns exactly what Fetch field values returns, with the same parameters and rules. It takes the signed_file_id or the pending_file_id.

🚧

Returns 400 until the envelope is complete

Before every recipient has signed, this path returns 400 invalid_document_state, and so does a canceled envelope. Fetch field values answers at every status, so use that one unless you only read completed envelopes. A fix that makes this path answer at every status is planned.

Path Params
int32
required

The signed envelope's signed_file_id. The envelope's pending_file_id works too.

Query Params
integer

Return only this recipient's fields. Use a recipient_id from recipients. For a recipient group, use a member's recipient_id, since a group's ID returns 400. Send one ID. If you repeat the parameter, only the first one is used.

string

Return only these field types, as a comma-separated list such as text,checkbox,combobox. Use lowercase type names: signature, initials, stamp, date, name, email, title, text, checkbox, combobox, and radio. Any other value returns 400.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json