GET custom completed field values via API

124 views Asked by At

Is it possible to get the values from a completed document that used a template?

I'm looking at the RESTful API section here

We use DocuSign for customers to fill out a Direct Debit form and accompanying address details. I'd like to get these via the API and create a CSV file for submission to our Direct Debit broker. Customer services said no, but don't think they understood the question :-)

1

There are 1 answers

3
Ergin On

The API page that you have linked to is for Custom Fields not recipient tabs. To be very clear, Custom Fields are fields at the Envelope level and are used for labeling, tracking, and searching your account envelopes.

Recipient Tabs are the fields that your signers fill out when completing your documents. They are unique to the various types of Recipients you can add to your transactions (such as signers, inPersonSigners, carbonCopy, etc.) More on Recipients here.

If you add tabs for your recipients, once the document is complete you can make the Get Tab Information for Recipient API call to retrieve the actual values.

Example:

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Sample Response:

    "approveTabs":[{
        <Tab information removed>
    }],
    "textTabs":[{
        <Tab information removed>
    }],
    "signHereTabs":[{
        <Tab information removed>
    }]
    }