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

Set Up a OneSpan Account

Before you start the setup, you must have a OneSpan account. Then, create a client app in your OneSpan account. While creating a client app, you get client ID and client secret parameter values. These parameter values are required to create the configuration for OneSpan. 

For more information on creating a client app, see Creating Client App in OneSpan. 

Integrate OneSpan with the Conga eSignature Service

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

MethodPUT
Endpoint/configurations
Request Body
{
    "signProvider": "OneSpan",
    "value": "{\"clientId\":\"<client ID>\",\"clientSecret\":\"<client secret>\"}"
    "default": false,
    "active": true,
 }
CODE

Replace <client ID> and <client secret> with the exact values.

Response

A 204 response code.

Create a Transaction

Once OneSpan 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 OneSpan 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 OneSpan from the drop-down list.

  • Payload: Enter payload.

    Sample Payload

    {
    "name": "Agreement Document",
    "recipients": [{
        "firstName": "First",
        "lastName": "Last",
        "email": "lfirst@conga.com",
        "signerType": "EXTERNAL_SIGNER",
        "index": "0"
    }]
}
    CODE
  • 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:

MethodGET
Endpoint

/transaction/{transactionId}

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

MethodGET
Endpoint/transaction/{transactionId}/recipients/{recipientId}/signingurls
Request Parameters 
  • transactionId: Enter a transaction ID.
  • recipientId: Enter a recipient ID. 
  • signProvider: Select OneSpan 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 OneSpan from the drop-down list.
ResponseA 204 response code. 

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