Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Sending Documents for eSignature with Sertifi Using the Conga eSignature API

This use case describes how to integrate Sertifi 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 Sertifi account
  2. Integrate Sertifi with the Conga eSignature service
  3. Create a transaction
  4. Send for eSignature

Set Up a Sertifi Account

Before you start the setup, you must have a Sertifi account. Then, you need a API code to integrate Sertifi with the Conga eSignature Service.

To get the API code

  1. Log in to your Sertifi account.
  2. Navigate to the Administrator tab.
  3. Click Account Settings.
  4. Copy the API code.

Integrate Sertifi with the Conga eSignature Service

To integrate Sertifi with the Conga eSignature service, create the configuration using the following API:

Method

PUT

Endpoint

/configurations

Request Body

{
    "signProvider": "Sertifi",
     "value": "{\"apiCode\":\"<API Code>\",
              \"senderEmailAddress\":\"<Sender email address>\",
              \"senderEmailDisplayName\":\"<sender email display name>\"}"
    "default": false,
    "active": true,
}

Replace <API code>, <Sender email address>, and <sender email display name> with the exact values.

The email address used in the configuration must belong to an administrator or user within Sertifi.

Response

A 204 response code.

Create a Transaction

Once Sertifi 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:

Method

GET

Endpoint

/settings

Request Parameter

signProvider: Select Sertifi 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:

Method

POST

Endpoint

/transactions

Request Body

  • signProvider: Select Sertifi from the drop-down list.
  • Payload: Enter payload.

    Sample Payload

    {
        "name": "Agreement Document",
        "recipients": [{
            "firstName": "First",
            "lastName": "Last",
            "email": "flast@conga.com",
            "signerType": "SIGNER",
            "index": "0"
        }]
    }
  • File: Select the document.

Response

This API returns a transaction ID, which you can use to send the transaction 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:

Method

GET

Endpoint

/transaction/{transactionId}

Request Parameters

  • transactionId: Enter a transaction ID.
  • signProvider: Select Sertifi 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:

Method

GET

Endpoint

/transaction/{transactionId}/taggingurls

Request Parameters

  • transactionId: Enter a transaction ID.
  • signProvider: Select Sertifi from the drop-down list.

Response

This 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 SIGN, and then SEND to send the document for eSignature. 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 do not want to send the document directly from the tagging page, you can generate a signing URL and send it to the recipients through API. Call the following API to get the signing URL:

Method

GET

Endpoint

/transaction/{transactionId}/recipients/{recipientId}/signingurls

Request Parameters

  • transactionId: Enter a transaction ID.
  • recipientId: Enter a recipient ID.
  • signProvider: Select Sertifi from the drop-down list.

Response

This 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:

Method

POST

Endpoint

/transaction/{transactionId}

Request Parameters

  • transactionId: Enter a transaction ID.
  • signProvider: Select Sertifi from the drop-down list.

Response

A 204 response code.

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