Evia Sign
  • Welcome to Evia Sign
    • What can Evia Sign do?
  • How to send signature request?
    • How to enable multiple signatories to access and sign documents at the same time?
    • How to add approvers and CC recipients to a signature request?
    • How do you add authentication to your request?
    • How do you send a private message?
  • How to sign documents?
    • Opening a document through Evia Sign inbox
    • Explore the different ways to add your signature
  • How to draft documents?
    • Components of DRAFTS in Evia Sign
  • Explore Evia Sign Inbox
  • How to create and use templates
    • Components of TEMPLATES
  • How to save your signature and initial?
  • How to add date stamp to your signature?
  • How to set up automatic reminders & expiration for signature requests
  • Users
    • How to import O365 users?
    • How to add new users?
    • How to delete users?
    • How to activate and deactivate users?
  • How do I change the current subscription plan of my account?
    • How to cancel and renew plan?
    • How do I purchase additional user licenses?
  • How to work with Enadoc Integration?
  • Terms to be familiar
  • FAQs
    • How to login into Evia Sign?
    • How do I make an account recovery?
    • How do you configure stamps?
    • How do you manually send reminders to signatories?
    • How do you view document history?
    • How do you decline a document?
    • How do you download a document?
    • What is a digitally certified document?
    • How are additional user licenses purchased?
    • How do you send reminders to signatories?
    • How to modify your session duration?
    • How do I monitor the request usage of my Evia Sign account?
  • Release Notes
  • Evia Sign API
    • V1
      • Overview
      • Authorization of the API Access
      • Requests
        • Document Upload
        • Send Requests
      • Request Types
        • Template
        • Fixed Positioning
        • Auto Stamping
    • V2
      • Welcome to Evia Sign API Version2
      • How to Migrate from API v1 to v2 - Beginner Guide
      • Authorization & Authentication
        • How to Register Your Application
        • Requesting the Authorization Code
        • Exchange Authorization Code for Access Token
      • Document Upload
      • Create Signature Request
      • Add Signatories to a Request
      • Add Stamps to a Signatory
      • Send Signature Request
      • Webhook Management
      • Glossary & Common Fields
  • Welcome to the New and Improved Evia Sign
  • How to Use the PDF Commenting Feature in Evia Sign
  • How to Upload Documents from SharePoint in Evia Sign
Powered by GitBook
On this page
  • Document Endpoint
  • Document Upload
  • Response Body
  • Error Messages
  • Creating the Signature Request

Was this helpful?

  1. Evia Sign API
  2. V1

Requests

In the initial phase of the document upload process, upon successful completion, a document token is issued as a unique identifier for the uploaded document. This token plays a crucial role in the subsequent step, enabling the seamless initiation of a sign request associated with the uploaded document. Serving as a key element, the document token establishes a connection between the uploaded content and the sign request, enhancing the workflow for a more efficient and secure document signing experience.

Document Endpoint

This API offers endpoints for handling document-related operations, including fetching document pages, and uploading documents to a rendering service. These operations require proper authorization through an access token included in the request header.

Document Upload

This API endpoint facilitates the upload of documents to the Evia Sign platform.

POST https://evia.enadocapp.com/_apis/sign/thumbs/api/Requests/document

Headers

Name
Type
Description

Authorization

Bearer

Access token should be sent as request header

Request Body

Name
Type
Description

File

The body contains the document data in a supported format. (PDF, DOC, DOCX)

The body of the response contains the document data, formatted in a supported file type such as PDF, DOC, or DOCX. Ensure that the uploaded document adheres to the specified format requirements.

Response Body

The response body will include the document token for identification and reference purposes.

Error Messages

Error
Error Description

If access token is invalid

Invalid access token

If access token is expired

Access token is expired

Creating the Signature Request

This API endpoint enables the creation of a new signature request.

Submit a POST request to the specified URL with the access token provided as a header to initiate the process.

POST https://evia.enadocapp.com/api/Requests?type=1,2,3

Headers

Name
Type
Description

Authorization

Bearer

Access token should be sent as request header

Upon successful creation, a status code of 200 is returned, confirming the successful initiation of the sign request.

Three Methods to Create a Sign Request

Type
Description

1

Initiate Signature Request from Template

2

Fixed Positioning for Standard Signature Request

3

Auto Stamping - (This is under the development phase)

Request Body for Template

{
        "templateId": "05117898-90db-45e5-b6b8-0230fd326e4f",
        "signatories": 
        [
            {
                "roleId": "9e7bb576-a2da-9fdc-d99c-958063dcfa19",
                "signatoryUserName": "Alison",
                "signatoryUserEmail": "alison@gmail.com"
            },
            {
                "roleId": "dd0caa50-58e1-bf28-441b-556bf70d5fc0",
                "signatoryUserName": "Stev Smith",
                "signatoryUserEmail": "stev@gmail.com"
            },
            {
                "roleId": "0612c8de-52b0-dc18-9a95-447041ebbe56",
                "signatoryUserName": "Jhone doe",
                "signatoryUserEmail": "jhone@gmail.com"
            }
        ]
}

Request Body for Fixed Positioning

{
  "Message": "Message",
  "Title": "Title",
  "IsParallelSign": true,
  "Documents": [
    "document token"
  ],
  "Signatories": [
    {
      "Color": "#7c95f4",
      "Email": "sample@gmail.com",
      "Name": "Jhone Doe",
      "Order": 1,
      "PrivateMessage": "Private Message",
      "signatoryType": 1,
      "OTP": {
        "IsRequired": true,
        "AccessCode": "12345",
        "Type": "2",
        "MobileNumber": "+94711234567"
      },
      "Stamps": [
        {
          "Color": "#7c95f4",
          "DocumentToken": "document token",
          "Order": 1,
          "Location": {
            "X": 100.5,
            "Y": 105.5
          },
          "StampSize": {
            "Height": 50,
            "Width": 100
          },
          "PageNumber": 1,
          "PageHeight": 1000,
          "PageWidth": 500,
          "Type": "signature"
        }
      ]
    }
  ]
}

PreviousAuthorization of the API AccessNextDocument Upload

Last updated 7 months ago

Was this helpful?