Download PDF
Download page Sending Documents for eSignature with DocuSign Using the Conga eSignature API.
Sending Documents for eSignature with DocuSign Using the Conga eSignature API
This use case describes how to send the documents for eSignature with DocuSign using the Conga eSignature integration API. Perform the following tasks to send the documents for eSignature:
- Set up the DocuSign account
- Configure DocuSign parameters
- Grant consent
- Create an envelope
- Send for signature
Set Up the DocuSign Account
Before you start the setup, you must have a DocuSign account. After creating a DocuSign account, you must create apps and keys in your account. For more information, see Creating Apps and Keys in DocuSign Account.
Configure DocuSign Parameters
Configure DocuSign parameters using the put_api-config-management-v1-configurations
endpoint.
Endpoint | https://<name of the instance>/api/config-management/v1/configurations |
---|---|
Request Method | PUT |
Request Body
{
"Category": "ESign",
"Name": "DocuSignConfig",
"Value": "{\"ImpersonatedUserId\":\"<user ID>\",\"APIAccountId\":\"<API account ID>\",\"AuthServer\":\"https://account.docusign.com\",\"IntegrationKey\":\"<integration key>\",\"BaseUrl\":\"https://demo.docusign.net\",\"AccountId\":\"<account ID>\",\"PrivateKey\":\"<private key>\",\"PublicKey\":\"<public key>\"}"
}
Replace the exact values for the user ID, API account ID, integration key, account ID, private key and public key. To get these values, log in to your DocuSign account.
Field Name | Description |
---|---|
User ID | Go to Settings > Apps and Keys, and look for User ID in the My Account Information section. |
API Account ID | Go to Settings > Apps and Keys, and look for API Account ID in the My Account Information section. |
Integration Key | Go to Settings > Apps and Keys, and look for Integration Key in the Apps and Integration Keys section. |
Account ID | Click your profile image in the upper-right corner. Your account number is under your name and/or org name in the drop-down menu. |
Private and Public Key | Use the private and public key values you received when you created apps and keys in your DocuSign account. |
After successfully executing this request, you will receive a 200
response code in the response body.
Grant Consent
To grant consent, open the following link in a new tab:
https://account.docusign.com/oauth/auth?response_type=code&scope=impersonation%20signature&client_id=<client ID>&redirect_uri=<redirect URI>
Replace the exact values for the client ID and redirect URI. To get these values, log in to your DocuSign account.
Field Name | Description |
---|---|
Client ID | Go to Settings > Apps and Keys, and look for Integration Key in the General Info section. |
Redirect URI | Go to Settings > Apps and Keys, and look for Redirect URIs in the Additional settings section. |
Once you open the link, the login screen is displayed for DocuSign. Enter your email and password to login, and Click Allow.
Create an Envelope
The post_api-esign-v1-esignatures
endpoint enables you to send the documents for eSignature through DocuSign.
Prerequisite
A contract with:
- An In Signature status category
- A Ready for Signature status
End Point | https://<name of the instance>/api/esign/v1/esignatures |
---|---|
Request Method | POST |
Request Body
{
"ObjectId": "eab35099-5b18-42b0-af8d-15013eb352a1",
"ObjectType": "Agreement",
"Email": {
"EmailSubject": "Contract document for sign",
"EmailContent": "Please sign the contract document."
},
"Recipients": [
{
"FirstName": "first",
"LastName": "last",
"Role": "signer",
"Email": "flast@conga.com",
"RoutingOrder": 1
}
],
"Name": "Envelope",
"DocumentIds": [
"df78b62e-8422-4043-8cf4-a7674acf2ec6"
],
"ReturnUrl": "<Any URL>"
}
Response Body
{
"Success": true,
"Data": {
"PackageId": "7838a7cd-55b4-4998-889c-b283c769efe8",
"TagUrl": "https://appdemo.docusign.com/auth-from-console?code=5aab0771-7437-40f4-a0db-47c426223433&t=45b6a39b-fb53-4d4b-89c8-1d0a2f50053e&from=https%3A%2F%2Fdemo.docusign.net&r=https%3A%2F%2Flocalhost%3A44373%2Fapi%2Fesign%2Fswagger%2Findex.html&view=true&DocuEnvelope=7838a7cd-55b4-4998-889c-b283c769efe8&e=7838a7cd-55b4-4998-889c-b283c769efe8&send=1&accountId=c6b6d723-d1a4-4043-a61a-c504b1a88f76&a=tag",
"Status": null
},
"Errors": null
}
If the request is successful, the response body returns a Tag URL. Click the URL to finalize the document in DocuSign.
Send for Signature
- Open the Tag URL in a new tab. This opens the documents inside the DocuSign Console.
Drag and drop the required fields into your document.
- To associate a field with a recipient, click the recipient's name and drag and drop the required fields into your document.
- To access any specific page of the document, scroll through it using the DOCUMENTS pane to the right.
- Click Send to send the document for eSignature.
After sending the document for eSignature, the contract's status category and status change to "other party signatures" and "in signatures", respectively.