Adobe Acrobat Sign

Here's everything you need to know about integrating Adobe Acrobat Sign with Knit and making API calls

Integrating Adobe Acrobat Sign with the Knit UI component

To get started with using Adobe Acrobat Sign APIs, first you'll have to create an OAuth application inside adobe

How to create OAuth app?

  1. To create an OAuth App, start by going to the Applications List page

  2. Select the Create (+) icon and provide details about your app.

  3. Choose the CUSTOMER domain and click on Save

  4. Now, you should see your newly created app in the Applications List.

  5. Select your app, and click on Configure OAuth for Application

  6. Here, do the following and then click on Save:

    1. Set the redirect URL to https://app.getknit.dev/oauth/authorize
    2. Select the following scopes: user_read, agreement_read, agreement_write, agreement_send, library_read, library_write, workflow_read, workflow_write, webhook_read, webhook_write

  7. From the applications list, click on "View/Edit". From this screen, copy for Application ID and Client Secret

Adding credentials in the Knit UI Component

Once you have your app credentials, you can use those to integrate with Adobe Acrobat Sign in the Knit UI Component

Enter the Client ID and Client Secret you got from above steps in the respective fields.

Next, enter your domain. If you sign in at https://secure.in1.adobesign.com, then your domain would be in1

That's it! Click on submit, and if you've entered the correct credentials, you should be redirected to the Adobe Sign login page, following which you will able to see that the Authorization has been successfully completed

Sending Document for Signature using Adobe Acrobat Sign

To send a document out for signature, we'll use Knit's Send Document for Signing API.

API Parameters

The following table gives an overview of the parameters of the API and how Adobe Acrobat Sign interprets them

ParameterIs parameter supported?Notes
signers[].nameSupportedName of the Signer
signers[].emailIdSupportedIs mapped to the Signer's identifier.
signers[].signTypeSupportedCan either be
ELECTRONIC
WRITTEN
signers[].commentSupportedIs mapped to the Signer's private comment.
documentNameSupported
documentSupportedDocument must be in pdf format
contentTypeSupportedThe content-type of the document you are sending. Click here to see examples : https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
notifyForSigningSupportedSends direct signing link over email
senderEmailIdSupported
referenceNumSupportedA document reference number that can be used across the lifecycle of the signing process
redirectURLSupportedPlease refer to <> to read more about post signature redirection
webhookURLSupportedPlease refer to <> to read more about post signature webhooks
signers[].phoneNot Supported
signers[].signCoordinatesNot Supported
senderNameNot Supported

πŸ“˜

Sign Type must be the same for all the signers

Adobe Sign does not support different sign type for different signers. The signers[].signType parameter must be the same for all the signers.

A cURL request to send a document for signature could look like:

curl --request POST \
     --url https://api.getknit.dev/v1.0/sign.document.send \
     --header 'Authorization: Bearer <YOUR_API_KEY>' \
     --header 'X-Knit-Integration-Id: <YOUR_INTEGRATION_ID>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "signers": [
    {
      "name": "Signer1",
      "emailId": "[email protected]",
      "signType": "ELECTRONIC",
      "comment": "Offer Letter"
    }
  ],
  "documentName": "Offer Letter.pdf",
  "document": "base64 string",
  "contentType": "application/pdf",
  "notifyForSigning": true,
  "referenceNum": "OL0001",
  "redirectURL": "https://server/redirect",
  "webhookURL": "https://server/webhook",
  "senderEmailId": "[email protected]"
}
'

And the response would look like:

{
  "documentSignId": "uniqueSignId",
  "redirectionSupported": true,
  "signers": [
    {
      "name": "Signer 1",
      "email": "[email protected]",
      "phone": null,
      "signUrl": null
    }
  ]
}

Getting the Sign URLs using Adobe Acrobat Sign

To get the sign URLs, we'll use Knit's Get Sign URLs API.

🚧

Use the Get Sign URLs API to fetch the signing URL for each signer

Adobe does not provide the signing URLs immediately after creating the document, and the signing URL is available after a delay of a few seconds. Use the Get Sign URLs API to fetch the sign URL when needed.

A cURL request to get the signing URLs could look like:

curl --request GET \
     --url 'https://api.getknit.dev/v1.0/sign.signers.url?documentSignId=<YOUR_DOCUMENT_ID>' \
     --header 'Authorization: Bearer <YOUR_API_KEY>' \
     --header 'X-Knit-Integration-Id: <YOUR_INTEGRATION_ID>' \
     --header 'accept: application/json'

And the response would look like:

{
  "signers": [
    {
      "email": "[email protected]",
      "signUrl": "https://sign_here.com/123"
    }
  ]
}