docusignapi - DocuSign ID Check with Embedded signing

Question

Using the REST API, I've been trying to create recipients for embedded signing and still require ID check. I can't seem to get it to work. The embedded signing part works fine but I'm not prompted for the ID check.

I know with embedded signing that user authentication duties can be handled by my app but our business would still like to have signers authenticate with the ID check feature.

So is it even possible to use the ID check feature with embedded signing?

Answer 1

How you specify recipient authentication method when using the DocuSign REST API to Create an Envelope will depend on whether you're:

1) creating an Envelope using a DocuSign Template OR 2) creating an Envelope by supplying document(s) as part of your Create Envelope API call.

In the first case (creating an Envelope using a DocuSign Template), you can use Composite Templates in your Create Envelope API call to specify ID Check as the form of recipient authentication (even if your template doesn't specify any form of recipient authentication). For example, this request will create an envelope (using a template) that specifies ID Check for an Embedded recipient:

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes

{
"emailSubject": "Please sign",
"emailBlurb": "Please sign...thanks!",
"status": "sent",
"compositeTemplates": [
    {
        "serverTemplates": [
            {
                "sequence": 1,
                "templateId": "YOUR_TEMPLATE_ID"
            }
        ],
        "inlineTemplates": [
            {
                "sequence": 2,
                "recipients": {
                    "signers": [
                        {
                            "email": "[email protected]",
                            "name": "Sally Adamson",
                            "recipientId": "1",
                            "clientUserId": "YOUR_CLIENT_USER_ID_VALUE",
                            "roleName": "Signer 1",
                            "requireIdLookup": "true",
                            "idCheckConfigurationName": "ID Check $"
                        }
                    ]
                }
            }
        ]
    }
]
}

Notice that you must set the requireIdLookup property to true and set the idCheckConfigurationName property to ID Check $ for the recipient, to specify ID Check as the recipient authentication method.

In the latter case (creating an Envelope by supplying documents as part of your Create Envelope API call), you simply need to set the requireIdLookup property to true and set the idCheckConfigurationName property to ID Check $ for the recipient. For example, this recipient structure (when included in the context of a Create Envelope API request) specifies that the recipient will be authenticated via ID Check:

"recipients": {
    "signers": [
        {
            "email": "[email protected]",
            "name": "Bob Adamson",
            "recipientId": "1",
            "routingOrder": "1",
            "idCheckConfigurationName": "ID Check $",
            "requireIdLookup": "true",
            "tabs": {
                "signHereTabs": [
                    {
                        "recipientId": "1",
                        "tabLabel": "Customer_Signature",
                        "documentId": "1",
                        "pageNumber": "1",
                        "xPosition": "100",
                        "yPosition": "100"
                    }
                ]
            }
        }
    ]
}