Consent Management (On-Premises)

How to set up Consent Management as part of Web Enrollment

Creating a Docusign Account

Setting Up Your Docusign Account

Creating a New App

1. Log in to Docusign.
2. In the top menu, click Admin.
3. In the left navigation, click Integrations > Apps and Keys.
4. On the page that appears, under Apps and Integration Keys, click the Add App and Integration Key button.
   
5. In the dialog box that appears, enter a name for the app (such as Alcatraz) and then click Create App.
   A page with app settings appears.
6. Under General Info, take a note of the Integration Key.
   You will need it later when enabling consent in Alcatraz Admin Portal.
   
7. Under Authentication, take the following actions:
   1. Under User Application, ensure that you set the options as follows:
      • Is your application able to securely store a client secret? is set to Yes.
      • Authentication Method for your App > Require Proof Key for Code Exchange (PKCE) is unchecked.
      • No keys are present under Secret Keys.
   2. Under Service Integration, generate new RSA keys or upload your own, if you have an existing certificate infrastructure:
      • To generate new RSA keys:
        1. Click Generate RSA.
        2. In the dialog box that opens, do the following:
           1. Copy the Public Key by clicking the Copy to clipboard button next to it.
           2. On your computer, create an empty plain-text file and paste the public key in it.
           3. Save the public key file as public.pem.
           4. Go back to Docusign.
           5. Copy the Private Key by clicking the Copy to clipboard button next to it.
           6. On your computer, create an empty plain-text file and paste the private key in it.
           7. Save the private key file as private.pem.
              An ID representing the key appears in the RSA Keypairs (ID) list.
      • To upload existing RSA keys:
        1. Click Upload RSA.
        2. In the Upload Public RSA Key dialog box that opens, paste the contents of your public key.
        3. Click Upload Key.
           An ID representing the key appears in the RSA Keypairs (ID) list.
           
8. Under Additional Settings, do the following:
   1. In Redirect URLs, click Add URI and then enter https://localhost:8000 in the text box that appears.
   2. Leave Link to Privacy Policy empty.
   3. Leave Link to Terms of Use empty.
   4. Under CORS Configuration, leave everything unchanged.
   5. Under Origin URLs, leave everything unchanged.
   6. Under Allowed HTTP Methods, ensure that all boxes are unchecked.
      
9. Click Save.
   Your Docusign app is complete.
10. At the top of the screen, locate the My Account Information section and take a note of User ID.
    You will need this value when setting up Alcatraz Admin Portal.
    

Granting Scopes to the App

• signature
• impersonation
• click.manage
• click.send

1. Construct the grant URL:
   <SERVER>/oauth/auth?response_type=code&scope=signature%20impersonation%20click.manage%20click.send&client_id=<INTEGRATION_KEY>&redirect_uri=https://localhost:8000
   
   Where:
   Replace <SERVER> with the appropriate Docusign API server address:
   For your production Docusign environment: https://account.docusign.com
   For your development Docusign environment (for testing, for example): https://account-d.docusign.com
   Replace <INTEGRATION_KEY> with your app's Integration Key that you took a note of earlier.
   
   Production environment example:
   https://account.docusign.com/oauth/auth?response_type=code&scope=signature%20impersonation%20click.manage%20click.send&client_id=xxxxf4cf-0c7f-4e80-aebd-c779e25dxxxx&redirect_uri=https://localhost:8000
2. Paste the URL in your web browser's address bar and press Enter.
3. If prompted by Docusign, log in to your Docusign account.
4. On the Your App Name is requesting access screen that appears, click Allow Access.
   

• If you get the The redirect URI is not registered properly with Docusign error, then double-check if the redirect URL that you entered when creating the Docusign app is the same as the one at the end of the URL.
• If you get the The client id provided is not registered with Docusign error, then double-check if you have properly inserted the Integration Key of the correct Docusign app inside the URL.

Creating a Consent Template

1. Create or source a PDF document containing the legal text required by your organization.
2. Log in to Docusign.
3. In the top navigation, click Templates
4. In the left navigation, click Start > Envelope Templates > Create a Template.
   
   A template wizard appears.
5. In Template Name, give the template a meaningful name.
   Example: `Web Enrollment Consent Template`
6. Under Add documents, click Upload > Browse, and then, in the file browser that appears, select the PDF file that you prepared.
7. Click Next.
8. Under Add recipients, do the following:
   1. In Role, enter Signer.
   2. In the drop-down list on the right of Role, select Needs to Sign.
   3. Leave Name empty.
   4. Leave Email empty.
      
      NOTE: Web Enrollment does not support the multiple recipients option Add Recipient.
      
      
9. Under Add Message, specify the content of the email:
   NOTE: Web Enrollment does not support the multiple recipients-related Custom message and language for each recipient option.
   
   1. In Subject and Message, enter any text.
      Web Enrollment does not utilize the Subject and Message text in any way.
      
   2. In Envelope Types, select a suitable type describing the purpose of the consent template or if you cannot find one, select Other and type a type of your choosing in the box that appears below.
      
10. Click Next.
    A visual document editor appears, showing the content of your PDF document.
11. Ensure that the drop-down list above the fields side-bar shows Signer.
    
12. Using drag and drop, add the signature-related fields that you want your users to fill in when accepting your biometric data processing consent.
    For example, drag the following onto the canvas:
    Signature (appears on the template as Sign)
    Name (appears on the template as Full Name)
    Date Signed
    
    
13. Click Save and Close to complete the template.
14. In the list of templates, click your template's name.
    A template details screen appears.
15. Under the template name, click Template ID to reveal the unique template ID and take a note of it.
    You will need this value when setting up Alcatraz Admin Portal.
    

Setting Up Alcatraz Admin Portal

1. Log in to Alcatraz Admin Portal as an Account Administrator.
2. In the left menu, go to Accounts > Account Settings.
3. Under Account Configuration, expand Web Enrollment.
4. Toggle Enable Web Enrollment on.
5. Check Consent Management.
6. Click Custom Consent and fill in the following fields:
   NOTE: Alcatraz Consent is a backwards-compatibility option designed only for existing consent management users. As an existing user, you can either specify your own Docusign account and continue using consent management with it, or do nothing and keep using Alcatraz Consent.
   • In Account Domain, enter the Docusign authentication service URL:
     • To use your production Docusign environment: account.docusign.com
     • To use your development Docusign environment (for testing purposes for example): account-d.docusign.com
   • In Integration Key, enter the Integration Key that you took a note of in Setting Up Your Docusign Account.
   • In User ID, enter the User ID that you took a note of in Setting Up Your Docusign Account.
   • In Template ID, enter the Template ID that you took a note of in Creating a Consent Template.
   • In Upload RSA Private Key, click and select the private.pem file that you created in Setting Up Your Docusign Account.
     
7. Optionally, click Test Docusign Connection to see if the entered values result in a successful connection.
8. Click Submit.
9. In the dialog box that opens, review your settings and then click Confirm to complete the setup.