This use case describes how to integrate DocuSign with Conga eSignature service, create a transaction, and send the documents for eSignature using the Conga eSignature integration API. Perform the following tasks to send documents for eSignature: 

  1. Set up a DocuSign account
  2. Integrate DocuSign with the Conga eSignature service
  3. Create a transaction 
  4. Send for eSignature 

Set Up a DocuSign Account

Before you start the setup, you must have a DocuSign account. Then, create apps and keys in your DocuSign account. While creating apps and keys, you get integration key, secret key, and redirect URL parameter values. These parameter values are required to create the configuration for DocuSign. 

For more information on creating apps and keys, see Creating Apps and Keys in DocuSign. 

Integrate DocuSign with the Conga eSignature Service

Integrating DocuSign with the Conga eSignature service is a two-step OAuth process: 

  1. Create a configuration for DocuSign, which returns a consent URL. Open the consent URL in a browser, log in to your DocuSign account, and grant consent. After giving consent, you are redirected to the configured redirect URL in a new browser window. This URL contains an auth code. Copy the auth code from the URL. To create the configuration, call the following API:

    MethodPUT
    Endpoint/configurations
    Request Body
    {
    "signProvider": "DocuSign",
        "value": "{\"integrationKey\":\"<integrationKey>\",
              \"secretKey\":\"<secretKey>\",
              \"redirectUri\":\"<redirectUri>\"}"
        "default": false,
        "active": true,      
}
    CODE

    Replace <integration key>, <secret key>, and <redirect URI> with the exact values.

    Response

    A 200 response code with a consent URL.

  2. Configure the auth code using the following API: 

    MethodPUT
    Endpoint/configurations/codes
    Request ParametersignProvider: Select DocuSign from the drop-down list.
    Request Body
    {
  "code": "string"
}
    CODE

    Replace the string with the auth code.

    Response

    A 204 response code. 

Create a Transaction

Once DocuSign and the Conga eSignature service are integrated, you can create a transaction. To create a transaction, you must prepare a transaction payload. Call the following API to get the exact transaction payload field data: 

MethodGET
Endpoint/settings
Request ParametersignProvider: Select DocuSign from the drop-down list.
Response

This API returns a transaction object with each field's settings, such as which fields are required,

optional, or not supported, the data type, and the name and description of the fields.

After preparing a transaction payload, call the following API to create a transaction:

MethodPOST
Endpoint/transactions
Request Body
  • signProvider: Select DocuSign from the drop-down list.

  • Payload: Enter payload.

    Sample Payload

    {
"name": "Agreement Document",
"embeddedSigning": "true",
"returnUrl": "<Any URL>",
"recipients": [
{
"firstName": "First",
"lastName": "Last",
"email": "flast@conga.com",
"signerType": "SIGNER",
"index": "0"
}
],
"email": {
"subject": "Agreement Document for Sign"
}
}
    CODE
  • File: Select the document.
Response
This API returns a transaction ID, which you can use to send the transaction to the recipients. 

When the embeddedSigning value is true, the recipient does not receive an invitation email to review and sign the document. You must generate a signing URL from the API and send it to the recipients. 

Send for Signature

After creating a transaction, you need a transaction ID, recipient ID, and document ID to get the tagging URL. Once you get the tagging URL, you can add fields for each recipient to your document and send the document for eSignature. 

Get transaction details

Call the following API to get the transaction ID, recipient ID, and document ID:

MethodGET
Endpoint

/transaction/{transactionId}

Request Parameters
  • transactionId: Enter a transaction ID.
  • signProvider: Select DocuSign from the drop-down list.
Response

This API returns transaction details such as recipient details, document details, and reminder and expiration settings.

Get a tagging URL

Call the following API to get the tagging URL: 

MethodGET
Endpoint/transaction/{transactionId}/taggingurls
Request Parameters
  • transactionId: Enter a transaction ID.
  • signProvider: Select DocuSign from the drop-down list.
ResponseThis API returns a tagging URL, transaction ID, recipient ID and Document ID. 

Open the tagging URL in a browser to view the tagging page, which enables you to add fields for each recipient to your document. Click Send to send the document for eSignature. If you set the embeddedSigning parameter value to false when creating a transaction, the recipient receives an invitation email to review and sign the document. The recipient can open the document from the email and sign it.

Send the transaction

If you set the embeddedSigning parameter value to true when creating a transaction, the recipient does not receive an invitation email to review and sign the document. You must generate a signing URL and send it to the recipients. Call the following API to get the signing URL: 

MethodGET
Endpoint/transaction/{transactionId}/recipients/{recipientId}/signingurls
Request Parameters 
  • transactionId: Enter a transaction ID.
  • recipientId: Enter a recipient ID. 
  • signProvider: Select DocuSign from the drop-down list.
ResponseThis API returns a signing URL, transaction ID, recipient ID, and Document ID. 

Once you get the signing URL, you can send it to the recipients. Call the following API to send the transaction:

MethodPOST
Endpoint/transaction/{transactionId}
Request Parameters
  • transactionId: Enter a transaction ID.
  • signProvider: Select DocuSign from the drop-down list.
ResponseA 204 response code. 

The recipient can open the document from the signing URL and sign it.