Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Updating your application to use the DocuSign API version 2.1

Updated on April 6, 2022

Take advantage of new features and usability improvements of DocuSign by configuring your application to use the latest version of the DocuSign API.

The DocuSign API version 2.1 provides the following benefits:
  • Support for advanced identity verification
  • Extensible Send via DocuSign V2 SmartShape
  • Audit trail for various envelope and recipient-related events in a case type
For example, with the DocuSign API version 2.1, you can enable advanced identity verification for envelope recipients.

Perform these steps if you already integrated your Pega application with DocuSign and want to upgrade the DocuSign API version that your application uses to version 2.1.

Before you begin: Download the PegaDocuSignIntegration_8 ZIP file that contains the DocuSign component pertaining to the API version 2.1 from Pega Marketplace.
  1. Import the ZIP file with the component to your Pega application.
    Note: During the import process, confirm the system request to overwrite the existing component with the new version.For more information, see Installing the DocuSign component.
  2. Optional: If your configuration includes the pySetEnvelopeCredentials data transform, to standarize the DocuSign service address and your DocuSign account ID across all case types, perform the following actions:
    1. Find and open the pySetEnvelopeCredentials data transform.
    2. On the Definition tab, delete data transform steps 1 through 5, as shown in the following figure:
      Adjusting the pySetEnvelopeCredentials data transform to v2.1 requirements
      The v2.0 pySetEnvelopeCredentials data transform with highlighted steps that require deletion.
    3. Provide the values for the DocuSign service domain and your DocuSigh acocunt ID in dedicated application settings.
      For more information, see Updating the DocuSign connection details.
    4. Confirm your settings by clicking Save.
  3. Optional: To adjust your DocuSign integration configuration to use advanced identity verification for envelope recipients, perform the following actions:
    1. Find and open the pyRecipientIdentityVerification data transform, and then save that data transform as part of your application ruleset.
    2. Find and open the pyAssignRecipientsToEnvelope data transform.
    3. On the Definition tab, delete data transform steps 2.6 through 2.10.
      These steps correspond to the SMS authentication configuration that is now part of the pyRecipientIdentityVerification data transform.
    4. Add a data transform step that has the following parameters:
      • ActionApply data transform
      • TargetpyRecipientIdentityVerification
      See the following figure for reference:
      Adjusting the pyAssignRecipientsToEnvelope data transform
      The pyAssignrecipientsToEnvelope data transform that shows which steps to add and which to delete if you want to use advanced identity verification.
    5. Confirm your settings by clicking Save.
What to do next: In the pyRecipientIdentityVerification data transform, configure your recipient identity verification settings. For more information, see Configuring advanced identity verification for envelope recipients.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us