Geek asks and answers

How to pre-populate $ ID Check fields in the Docusign API?

Does anyone know how to pre-populate the $ ID Check fields in the Docusign API? I cannot find the relevant information in the API manual. The guide provides a list of ways to populate the template.

+3
source share
2 answers

This answer contains a SOAP snippet and a full REST call in JSON with headers, a body, and two tabbed templates needed to execute the JSON body. A body with several parts is used so that when you add embedded templates and documents with dynamic PDF bytes, you are already set up.

SOAP documentation for IDCheck at DocuSign http://www.docusign.com/p/APIGuide/APIGuide.htm#Sending Group / IDCheckInformation.htm? Highlight = IDCheckInformationInput

Live DocuSign SOAP Help for methods, parameters and data models and methods in DocuSign https://www.docusign.net/api/3.0/dsapi.asmx

REST documentation for IDCheck at DocuSign http://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST API Links / Recipients / Subscribers Recipient .htm? Highlight = IDCheckConfigurationName

Live DocuSign REST Help on methods, parameters and data model and methods in DocuSign https://www.docusign.net/restapi/help

Via SOAP (part of the receiver fragment)

SOAP - XML ​​(not REST / XML (key values ​​are different))

        <Recipients>
           <Recipient>
              <ID>1</ID>
              <UserName>David Grigsby</UserName>
              <Email>dgrigsbyds+idcheck@gmail.com</Email>
              <Type>Signer</Type>
              <AccessCode/>
              <RequireIDLookup>true</RequireIDLookup>
              <IDCheckConfigurationName>ID Check $</IDCheckConfigurationName>
                                         <IDCheckInformationInput>
                                                        <AddressInformationInput>
                                                                       <AddressInformation>
                                                                                      <Street1>104 Bremen Dr</Street1>
                                                                       </AddressInformation>
                                                                       <DisplayLevel>Editable</DisplayLevel>
                                                        </AddressInformationInput>
                                                        <DOBInformationInput>
                                                                       <DisplayLevel>Editable</DisplayLevel>
                                                        </DOBInformationInput>
                                         </IDCheckInformationInput>                 
              <RoutingOrder>1</RoutingOrder>
              <Note/>
              <SignInEachLocation>false</SignInEachLocation>
           </Recipient>

XML IDCheck : https://docusigninc.box.com/s/u4pj47lwom01h0clbjcn

REST ( JSON )

, xml, ,

Google Chrome Postman REST SOAP .

Doc

DocA [box] https://docusigninc.box.com/s/cm1bf67prdoxmzoue8wd

DocB [box] https://docusigninc.box.com/s/1yl7rbjny61o3rfzv2t1

POST /restapi/v2/accounts/YourExternalAccountId/envelopes HTTP/1.1
Host: demo.docusign.net

HEADERS:
--------

X-DocuSign-Authentication: {"Username":"yourEmail","Password":"YourPassword","IntegratorKey":"YourIntegratorKey"}
Content-Type: multipart/form-data; boundary=AAA
Accept: application/json

BODY:
--------

--AAA
Content-Type: application/json
Content-Disposition: form-data

{
        "emailSubject": "Test 3",
        "emailBlurb": "Using two templates from composite template structure",
        "status": "sent",   
        "compositeTemplates": [{
               "serverTemplates": [{
                       "sequence": "1",
                       "templateId": "YourTemplateID1"
               }],
               "inlineTemplates": [{
                       "sequence": "1",
                       "recipients": {
                              "signers": [{
                                      "email": "youremail1@domain.com",
                                      "name": "your name (1)",
                                      "recipientId": "1",
                                      "roleName": "Role",
                                      "requireIDLookup": "true",
                                      "idCheckConfigurationName": "Check $",
                                      "idCheckInformationInput" : {
                                        "addressInformationInput" : 
                                        {
                                            "addressInformation" :
                                            {
                                                "street1" : "123 main street"
                                            },
                                            "displayLevelCode" : "Editable"
                                        },
                                        "dobInformationInput" : 
                                        {
                                            "displayLevelCode" : "Editable"
                                        }

                                      },                                      
                                      "tabs": {
                                             "textTabs": [{
                                                     "value": "YourName",
                                                     "tabLabel": "name"
                                             },
                                             {
                                                     "value": "YourFirstName",
                                                     "tabLabel": "first_name"
                                             }]
                                      }
                              }]
                       }
               }]
        },
        {
               "serverTemplates": [{
                       "sequence": "2",
                       "templateId": "YourTemplateID2"
               }],
               "inlineTemplates": [{
                       "sequence": "2",
                       "recipients": {
                              "signers": [{
                                      "email": "youremail2@domain.com",
                                      "name": "Your Name (2)",
                                      "recipientId": "1",
                                      "roleName": "Role",
                                      "tabs": {
                                             "textTabs": [{
                                                     "value": "Your Name (2)",
                                                     "tabLabel": "name"
                                             },
                                             {
                                                     "value": "YourLastName",
                                                     "tabLabel": "last_name"
                                             }]
                                      }
                              }]
                       }
               }]
        }]
}


--AAA--

Template1

XML [box] https://docusigninc.box.com/s/dru41hdcgo9cqffqxzi4

<?xml version="1.0" encoding="utf-8"?>
<EnvelopeTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.net/API/3.0">
    <EnvelopeTemplateDefinition>
        <TemplateID>82b2ce36-c6d1-41e5-9eb7-8c0d2b349057</TemplateID>
        <Name>A Simple</Name>
        <Shared>true</Shared>
        <TemplatePassword />
        <TemplateDescription />
        <LastModified>2014-02-25T19:57:01.337Z</LastModified>
        <PageCount>1</PageCount>
    </EnvelopeTemplateDefinition>
    <Envelope>
        <AccountId>6918840b-91f3-464a-a219-74df4df172a1</AccountId>
        <Documents>
            <Document>
                <ID>1</ID>
                <Name>a.pdf</Name>
                <PDFBytes>removed</PDFBytes>
            </Document>
        </Documents>
        <Recipients>
            <Recipient>
                <ID>1</ID>
                <UserName />
                <Email />
                <Type>Signer</Type>
                <AccessCode />
                <RequireIDLookup>false</RequireIDLookup>
                <SAMLAuthentication>
                    <SAMLAttributes />
                </SAMLAuthentication>
                <RoutingOrder>1</RoutingOrder>
                <Note />
                <RoleName>Role</RoleName>
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SignInEachLocation>false</SignInEachLocation>
            </Recipient>
        </Recipients>
        <Tabs>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>211</XPosition>
                <YPosition>63</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>Custom</Type>
                <Name>name</Name>
                <TabLabel>name</TabLabel>
                <Value />
                <CustomTabType>Text</CustomTabType>
                <CustomTabWidth>174</CustomTabWidth>
                <CustomTabHeight>11</CustomTabHeight>
                <CustomTabRequired>true</CustomTabRequired>
                <CustomTabLocked>false</CustomTabLocked>
                <CustomTabDisableAutoSize>false</CustomTabDisableAutoSize>
                <CustomTabValidationPattern />
                <CustomTabValidationMessage />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SharedTab>false</SharedTab>
                <RequireInitialOnSharedTabChange>false</RequireInitialOnSharedTabChange>
                <ConcealValueOnDocument>false</ConcealValueOnDocument>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>214</XPosition>
                <YPosition>98</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>Custom</Type>
                <Name>first_name</Name>
                <TabLabel>first_name</TabLabel>
                <Value />
                <CustomTabType>Text</CustomTabType>
                <CustomTabWidth>174</CustomTabWidth>
                <CustomTabHeight>11</CustomTabHeight>
                <CustomTabRequired>true</CustomTabRequired>
                <CustomTabLocked>false</CustomTabLocked>
                <CustomTabDisableAutoSize>false</CustomTabDisableAutoSize>
                <CustomTabValidationPattern />
                <CustomTabValidationMessage />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SharedTab>false</SharedTab>
                <RequireInitialOnSharedTabChange>false</RequireInitialOnSharedTabChange>
                <ConcealValueOnDocument>false</ConcealValueOnDocument>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>71</XPosition>
                <YPosition>142</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>SignHere</Type>
                <Name>Sign Here</Name>
                <TabLabel>Signature 3</TabLabel>
                <Value />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
        </Tabs>
        <Subject>Please DocuSign this document: a.pdf</Subject>
        <EmailBlurb />
        <SigningLocation>Online</SigningLocation>
        <AutoNavigation>true</AutoNavigation>
        <EnvelopeIdStamping>true</EnvelopeIdStamping>
        <AuthoritativeCopy>false</AuthoritativeCopy>
        <Notification>
            <Reminders>
                <ReminderEnabled>false</ReminderEnabled>
                <ReminderDelay>0</ReminderDelay>
                <ReminderFrequency>0</ReminderFrequency>
            </Reminders>
            <Expirations>
                <ExpireEnabled>true</ExpireEnabled>
                <ExpireAfter>120</ExpireAfter>
                <ExpireWarn>0</ExpireWarn>
            </Expirations>
        </Notification>
        <EnforceSignerVisibility>false</EnforceSignerVisibility>
        <EnableWetSign>true</EnableWetSign>
        <AllowMarkup>false</AllowMarkup>
        <AllowReassign>true</AllowReassign>
        <BrandId>c949b06b-5530-410e-b20b-12b3e5376957</BrandId>
    </Envelope>
</EnvelopeTemplate>

Template2

XML [box] https://docusigninc.box.com/s/hf3c03br9tpvntjatffl

<?xml version="1.0" encoding="utf-8"?>
<EnvelopeTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.net/API/3.0">
    <EnvelopeTemplateDefinition>
        <TemplateID>f1a039c0-61d2-4983-a889-4a2d0fd9802d</TemplateID>
        <Name>B Simple</Name>
        <Shared>true</Shared>
        <TemplatePassword />
        <TemplateDescription />
        <LastModified>2014-02-25T19:58:36.1Z</LastModified>
        <PageCount>1</PageCount>
    </EnvelopeTemplateDefinition>
    <Envelope>
        <AccountId>6918840b-91f3-464a-a219-74df4df172a1</AccountId>
        <Documents>
            <Document>
                <ID>1</ID>
                <Name>b.pdf</Name>
                <PDFBytes>removed</PDFBytes>
            </Document>
        </Documents>
        <Recipients>
            <Recipient>
                <ID>1</ID>
                <UserName />
                <Email />
                <Type>Signer</Type>
                <AccessCode />
                <RequireIDLookup>false</RequireIDLookup>
                <SAMLAuthentication>
                    <SAMLAttributes />
                </SAMLAuthentication>
                <RoutingOrder>1</RoutingOrder>
                <Note />
                <RoleName>Role</RoleName>
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SignInEachLocation>false</SignInEachLocation>
            </Recipient>
        </Recipients>
        <Tabs>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>211</XPosition>
                <YPosition>63</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>Custom</Type>
                <Name>name</Name>
                <TabLabel>name</TabLabel>
                <Value />
                <CustomTabType>Text</CustomTabType>
                <CustomTabWidth>174</CustomTabWidth>
                <CustomTabHeight>11</CustomTabHeight>
                <CustomTabRequired>true</CustomTabRequired>
                <CustomTabLocked>false</CustomTabLocked>
                <CustomTabDisableAutoSize>false</CustomTabDisableAutoSize>
                <CustomTabValidationPattern />
                <CustomTabValidationMessage />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SharedTab>false</SharedTab>
                <RequireInitialOnSharedTabChange>false</RequireInitialOnSharedTabChange>
                <ConcealValueOnDocument>false</ConcealValueOnDocument>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>214</XPosition>
                <YPosition>97</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>Custom</Type>
                <Name>last_name</Name>
                <TabLabel>last_name</TabLabel>
                <Value />
                <CustomTabType>Text</CustomTabType>
                <CustomTabWidth>174</CustomTabWidth>
                <CustomTabHeight>11</CustomTabHeight>
                <CustomTabRequired>true</CustomTabRequired>
                <CustomTabLocked>false</CustomTabLocked>
                <CustomTabDisableAutoSize>false</CustomTabDisableAutoSize>
                <CustomTabValidationPattern />
                <CustomTabValidationMessage />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <SharedTab>false</SharedTab>
                <RequireInitialOnSharedTabChange>false</RequireInitialOnSharedTabChange>
                <ConcealValueOnDocument>false</ConcealValueOnDocument>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
            <Tab>
                <DocumentID>1</DocumentID>
                <RecipientID>1</RecipientID>
                <PageNumber>1</PageNumber>
                <XPosition>71</XPosition>
                <YPosition>142</YPosition>
                <ScaleValue>1</ScaleValue>
                <Type>SignHere</Type>
                <Name>Sign Here</Name>
                <TabLabel>Signature 3</TabLabel>
                <Value />
                <TemplateLocked>false</TemplateLocked>
                <TemplateRequired>false</TemplateRequired>
                <Bold>false</Bold>
                <Italic>false</Italic>
                <Underline>false</Underline>
            </Tab>
        </Tabs>
        <Subject>Please DocuSign this document: a.pdf</Subject>
        <EmailBlurb />
        <SigningLocation>Online</SigningLocation>
        <AutoNavigation>true</AutoNavigation>
        <EnvelopeIdStamping>true</EnvelopeIdStamping>
        <AuthoritativeCopy>false</AuthoritativeCopy>
        <Notification>
            <Reminders>
                <ReminderEnabled>false</ReminderEnabled>
                <ReminderDelay>0</ReminderDelay>
                <ReminderFrequency>0</ReminderFrequency>
            </Reminders>
            <Expirations>
                <ExpireEnabled>true</ExpireEnabled>
                <ExpireAfter>120</ExpireAfter>
                <ExpireWarn>0</ExpireWarn>
            </Expirations>
        </Notification>
        <EnforceSignerVisibility>false</EnforceSignerVisibility>
        <EnableWetSign>true</EnableWetSign>
        <AllowMarkup>false</AllowMarkup>
        <AllowReassign>true</AllowReassign>
        <BrandId>c949b06b-5530-410e-b20b-12b3e5376957</BrandId>
    </Envelope>
</EnvelopeTemplate>
+6

, #...

 new Recipient
            {
                Email = email,                    
                Type = RecipientTypeCode.Signer,
                RequireIDLookup = true,
                IDCheckConfigurationName = "ID Check $",
                IDCheckInformationInput = new IDCheckInformationInput()
                {
                    AddressInformationInput = new AddressInformationInput()
                    {
                        AddressInformation = new AddressInformation() { 
                        City = city, 
                        State = state, 
                        Street1 = address,
                        Zip = zip }
                    },
                    DOBInformationInput = new DOBInformationInput() 
                    { 
                        DOBInformation = new DOBInformation() 
                        { 
                             DOB = dob
                        } 
                    },
                    SSN9InformationInput = new SSN9InformationInput() 
                    { 
                        SSN9Information = new SSN9Information()
                        {
                            SSN9 = ssn
                        }
                    }
                }
            };
0

More articles:


All Articles