Signeasy eSignature API

https://docs.signeasy.com/
Admin
This project provides guides, documentation, and resources for exploring, embedding, and integrating...
Tokens:77,616
Snippets:407
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create Envelope Request Example

Source: https://docs.signeasy.com/reference/create-an-envelope-rs-originals-templates

A JSON payload example for creating an envelope with multiple sources, recipients, and field mappings.

```json
{
  "is_ordered": false,
  "message": "Please sign the documents.",
  "embedded_signing": true,
  "sources": [
    {
      "id": 23190242,
      "type": "original",
      "name": "Offer Letter",
      "source_id": 1
    },
    {
      "id": 23190118,
      "type": "original",
      "name": "Employment Agreement",
      "source_id": 2
    },
    {
      "id": 12661,
      "type": "template",
      "name": "NDA",
      "source_id": 3
    },
    {
      "id": 12719,
      "type": "template",
      "name": "Service Agreement",
      "source_id": 4
    }
  ],
  "recipients": [
    {
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "recipient_id": 1
    },
    {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "recipient_id": 2
    }
  ],
  "cc": [
    {
      "email": "jack.harman@example.com"
    }
  ],
  "recipient_role_mapping": [
    {
      "role_id": 2,
      "recipient_id": 1,
      "source_id": 3
    },
    {
      "role_id": 1,
      "recipient_id": 1,
      "source_id": 3
    },
    {
      "role_id": 1,
      "recipient_id": 2,
      "source_id": 4
    }
  ],
  "fields_payload": [
    {
      "recipient_id": 1,
      "source_id": 1,
      "type": "date",
      "required": true,
      "page_number": "1",
      "position": {
        "x": 300,
        "y": 670,
        "height": 50
```

--------------------------------

### rs.link_sent JSON Payload Example

Source: https://docs.signeasy.com/reference/rslink_sent

Example structure of the JSON payload received when the rs.link_sent event is fired.

```json
{
   "data":{
      "status":"incomplete",
      "owner_first_name":"Jack",
      "expiry_time": 1683033398,
      "sources": [
        {
         "id": 33299021,
         "name": "LP Signing Contract Document",
         "type": "original" 
        },
        {
          "id" 33122312,
          "name": "LP Signing Contract Lease Document",
          "type": "original"
        }
      ],
      "recipients":[
         {
            "status":"not_viewed",
            "first_name":"",
            "last_name":"",
            "order_id":1,
            "last_modified_time":1505462028,
            "recipient_user_id":2,
            "recipient_id":3,
            "created_time":1505462028,
            "email":"hilton@gmail.com"
         },
         {
            "status":"not_viewed",
            "first_name":"",
            "last_name":"",
            "order_id":2,
            "last_modified_time":1505462028,
            "recipient_user_id":3,
            "recipient_id":4,
            "created_time":1505462028,
            "email":"timferry@gmail.com"
         }
      ],
      "owner_email":"jackbarb@gmail.com",
      "owner_last_name":"Barb",
      "next":3,
      "created_time":1505462028,
      "last_modified_time":1505462028,
      "has_markers":0,
      "is_ordered":0,
      "id":34732472,
      "owner_user_id":1
   },
   "metadata":{
      "token": "1AqZ3DEC4fr@21",
      "event_type":"rs.link_sent",
      "event_user_id":2,
      "client_id":null,
      "event_user":"hilton@gmail.com"
   },
   "request_info": {
        "name": "Jack",
        "required": true,
        "id" : 49367567,
        "url": "https://localhost:8090"
    }
}
```

--------------------------------

### GET /original/

Source: https://docs.signeasy.com/reference/list-all-originals

Retrieve a list of all original files for the authenticated user.

```APIDOC
## GET /original/

### Description
Retrieve information about all the original files of a user.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/original/

### Response
#### Success Response (200)
- **count** (integer) - The total number of files.
- **files** (array) - A list of file objects.
  - **created_time** (integer) - The timestamp when the file was created.
  - **id** (integer) - The unique identifier of the file.
  - **last_modified_time** (integer) - The timestamp when the file was last modified.
  - **name** (string) - The name of the file.

#### Response Example
{
    "count": 2,
    "files": [
        {
          "created_time": 1590751553,
          "id": 23188790,
          "last_modified_time": 1590751553,
          "name": "IT Contract - Employee (Anirjit Bakshi).pdf"
        },
        {
            "created_time": 1588142205,
            "id": 23187514,
            "last_modified_time": 1588142206,
            "name": "IT Contract - Employee (Prashanth Raghu).pdf"
        }
    ]
}
```

--------------------------------

### GET /v3/template

Source: https://docs.signeasy.com/reference/list-templates

Retrieves a list of all templates available in the account.

```APIDOC
## GET /v3/template

### Description
Retrieves a list of all templates available in the account.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/template

### Response
#### Success Response (200)
- Returns a list of templates.

#### Error Response (400)
- Bad Request
```

--------------------------------

### Envelope Signed Documents Response Example

Source: https://docs.signeasy.com/reference/list-envelope-signed-documents

Example JSON response showing the structure of signed documents, including file details and recipient information.

```json
{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": 0,
            "checksum": "70f9f896f4034d242cb3ff9268c8417a60a84f5d0ae07a9dedb75a6a22500a7a",
            "created_time": 1574852499,
            "fa_aadhaar_enabled": null,
            "id": 14862799,
            "last_modified_time": 1574852499,
            "name": "Employment Agreement - Prashanth Raghu.pdf",
            "pending_file": {
                "created_time": 1574852276,
                "envelope_size": 2,
                "has_markers": 1,
                "id": 1000192,
                "is_envelope": 1,
                "is_in_person": 0,
                "is_ordered": 0,
                "last_modified_time": 1574852504,
                "name": "Employment Agreement - Prashanth Raghu.pdf",
                "next": 384952,
                "owner_company": "",
                "owner_email": "spatro@signeasy.com",
                "owner_first_name": "Sunil",
                "owner_last_name": "Patro Ek",
                "recipients": [
                    {
                        "created_time": 1574852387,
                        "email": "prashanth.raghu@signeasy.com",
                        "first_name": "Prashanth Raghu",
                        "last_modified_time": 1574852497,
                        "last_name": "",
                        "order_id": 1,
                        "recipient_id": 384951,
                        "recipient_user_id": 3626367,
                        "status": "finalized"
                    },
                    {
                        "created_time": 1574852388,
                        "email": "jiril.joseph@signeasy.com",
                        "first_name": "Jiril Joseph",
                        "last_modified_time": 1574852435,
                        "last_name": "",
                        "order_id": 2,
                        "recipient_id": 384952,
                        "recipient_user_id": 3625901,
                        "status": "finalized"
                    }
                ],
                "status": "complete"
            },
            "public_identifier": "pHkDiFc8I+D1MZnUO6i7mg=="
        },
        {
            "aadhaar_enabled": 0,
            "checksum": "70f9f896f4034d242cb3ff9268c8417a60a84f5d0ae07a9dedb75a6a22500a7a",
            "created_time": 1574852499,
            "fa_aadhaar_enabled": null,
            "id": 14862799,
            "last_modified_time": 1574852499,
            "name": "Employment Agreement - Anirjit Bakshi.pdf",
            "pending_file": {
                "created_time": 1574852276,
                "envelope_size": 2,
                "has_markers": 1,
                "id": 1000192,
                "is_envelope": 1,
                "is_in_person": 0,
                "is_ordered": 0,
                "last_modified_time": 1574852504,
                "name": "Employment Agreement - Anirjit Bakhsi.pdf",
                "next": 384952,
                "owner_company": "",
                "owner_email": "spatro@signeasy.com",
                "owner_first_name": "Sunil",
                "owner_last_name": "Patro Ek",
                "recipients": [
                    {
                        "created_time": 1574852387,
                        "email": "anirjit.bakshi@signeasy.com",
                        "first_name": "Anirjit Bakshi",
                        "last_modified_time": 1574852497,
                        "last_name": "",
                        "order_id": 1,
                        "recipient_id": 384951,
                        "recipient_user_id": 3626367,
                        "status": "finalized"
                    },
                    {
                        "created_time": 1574852388,
                        "email": "jiril.joseph@signeasy.com",
                        "first_name": "Jiril Joseph",
                        "last_modified_time": 1574852435,
                        "last_name": "",
                        "order_id": 2,
                        "recipient_id": 384952,
                        "recipient_user_id": 3625901,
                        "status": "finalized"
                    }
                ],
                "status": "complete"
            },
            "public_identifier": "pHkDiFc8I+D1MZnUO6i7mg=="
        }]
}
```

--------------------------------

### GET /rs/

Source: https://docs.signeasy.com/reference/list-request-signature-without-markers

Fetches a list of all envelopes.

```APIDOC
## GET /rs/

### Description
Fetch all envelopes.

### Method
GET

### Endpoint
/rs/

### Response
#### Success Response (200)
- **count** (integer) - The total number of envelopes.
- **files** (array) - A list of envelope objects.

#### Response Example
{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 0,
            "id": 235641,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Employment Agreement - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "spatro@gmail.com",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "prashanth.signeasy@gmail.com",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                },
                {
                    "created_time": 1557465371,
                    "email": "jiril.joseph@signeasy.com",
                    "first_name": "Jiril",
                    "last_modified_time": 1557465371,
                    "last_name": "Joseph",
                    "order_id": 2,
                    "recipient_id": 377929,
                    "recipient_user_id": 3626367,
                    "status": "not_viewed"
                }
            ],
            "status": "incomplete"
        }
    ]
}
```

--------------------------------

### GET /me/signed/

Source: https://docs.signeasy.com/reference/fetch-all-self-signed-files

Retrieve information about all the signed files using self signing of a user.

```APIDOC
## GET /me/signed/

### Description
Retrieve information about all the signed files using self signing of a user.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/me/signed/

### Response
#### Success Response (200)
- **count** (integer) - The total number of signed files.
- **files** (array) - A list of signed file objects.

#### Response Example
{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": null,
            "checksum": "a987516b47d84caa1ecb3ddca86589f3b7dec31a7fa77e7f458d5788bfe04282",
            "created_time": 1554285219,
            "fa_aadhaar_enabled": null,
            "id": 14845488,
            "last_modified_time": 1554285219,
            "name": "Employment Contract - Rajith Noojibial.pdf",
            "pending_file": null,
            "public_identifier": "izrok4vVhS9hRz3aAzUbeg=="
        },
        {
            "aadhaar_enabled": null,
            "checksum": "e9e65ea551760df8bc9c4252fa90fa152d549609bd363a24b2a499aefc94eb21",
            "created_time": 1554285323,
            "fa_aadhaar_enabled": null,
            "id": 14845489,
            "last_modified_time": 1554285323,
            "name": "Employment Contract - Prashanth Raghu.pdf",
            "pending_file": null,
            "public_identifier": "MuOSz0k+WpWPDGoMroj72w=="
        }
    ]
}
```

--------------------------------

### GET /me/

Source: https://docs.signeasy.com/reference/fetch-user-details

Retrieves the details of the currently authenticated user.

```APIDOC
## GET /me/

### Description
Retrieves the profile details of the currently authenticated user.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/me/

### Response
#### Success Response (200)
- **id** (integer) - User ID
- **email** (string) - User email address
- **is_paid** (integer) - Paid status
- **activation_time** (integer) - Account activation timestamp
- **subscription_expiry_time** (integer) - Subscription expiry timestamp
- **last_modified_time** (integer) - Last modified timestamp
- **created_time** (integer) - Account creation timestamp
- **imported_file_count** (integer) - Number of imported files
- **signed_file_count** (integer) - Number of signed files
- **first_name** (string) - User first name
- **last_name** (string) - User last name
- **company** (object) - Company information
- **account_type** (integer) - Account type identifier
- **document_credits** (integer) - Remaining document credits
- **is_auto_renew** (integer) - Auto-renewal status
- **status** (integer) - Account status
- **is_social** (integer) - Social account status
- **email_verified** (integer) - Email verification status

#### Response Example
{
    "id": 9978630,
    "email": "john@example.com",
    "is_paid": 1,
    "activation_time": 1661229108,
    "subscription_expiry_time": 1730717973,
    "last_modified_time": 1699095581,
    "created_time": 1661228992,
    "imported_file_count": 0,
    "signed_file_count": 26,
    "first_name": "John",
    "last_name": "Doe",
    "company": null,
    "account_type": 10,
    "document_credits": 0,
    "is_auto_renew": 1,
    "status": 1,
    "is_social": 0,
    "email_verified": 1
}
```

--------------------------------

### GET /rs/envelope/signed/

Source: https://docs.signeasy.com/reference/list-envelope-signed-documents

Retrieve a list of all signed envelopes for the authenticated user.

```APIDOC
## GET /rs/envelope/signed/

### Description
Retrieve information about all the signed files of a user created using the envelopes API.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/rs/envelope/signed/

### Response
#### Success Response (200)
- **200** - Successful retrieval of signed envelopes.
```

--------------------------------

### Envelope Creation Response Examples

Source: https://docs.signeasy.com/reference/create-an-envelope-rs-originals-templates

Provides the JSON structure for successful envelope creation and error responses.

```json
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "id": 103449717,
                      "recipients": [
                        {
                          "recipient_id": 45037881,
                          "email": "mario@example.com",
                          "first_name": "Mario",
                          "last_name": "A"
                        },
                        {
                          "recipient_id": 45037882,
                          "email": "luigi@example.com",
                          "first_name": "Luigi",
                          "last_name": "B"
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 1005965,
                      "default": 0
                    },
                    "recipients": {
                      "type": "array",
                      "items": {
                        "properties": {
                          "recipient_id": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "first_name": {
                            "type": "string"
                          },
                          "last_name": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
```

--------------------------------

### GET /v3/original/{original_id}/download

Source: https://docs.signeasy.com/reference/download-an-original-document

Downloads the original document as a PDF file.

```APIDOC
## GET /v3/original/{original_id}/download

### Description
Download the original document as a PDF. The API will always return the file content as PDF irrespective of the format of the document uploaded to Signeasy.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/original/{original_id}/download

### Parameters
#### Path Parameters
- **original_id** (int32) - Required - The unique identifier of the original document.

### Response
#### Success Response (200)
- Returns the file content as a PDF.

#### Error Response (400)
- Bad Request
```

--------------------------------

### GET https://auth.signeasy.com/authorize

Source: https://docs.signeasy.com/docs/authorization-code-flow

Initiates the authorization flow by displaying a consent screen to the user.

```APIDOC
## GET https://auth.signeasy.com/authorize

### Description
Initiates the authorization flow by displaying a consent screen to the user to review requested permissions.

### Method
GET

### Endpoint
https://auth.signeasy.com/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The client ID received when creating the app.
- **redirect_uri** (string) - Required - The URL where users are sent after authorization.
- **scope** (string) - Required - A space-delimited list of scopes.
- **response_type** (string) - Required - Must be 'code'.
- **state** (string) - Optional - Unique value to mitigate CSRF attacks.
- **audience** (string) - Required - The unique identifier of the audience, always https://api-ext.signeasy.com/.
```

--------------------------------

### GET /template/rs/signed/{signed_file_id}/

Source: https://docs.signeasy.com/reference/fetch-details-of-signed-file

Retrieves the details of a signed template by its ID.

```APIDOC
## GET /template/rs/signed/{signed_file_id}/

### Description
Fetch a signed template.

### Method
GET

### Endpoint
/template/rs/signed/{signed_file_id}/

### Parameters
#### Path Parameters
- **signed_file_id** (integer) - Required - The unique identifier of the signed file.

### Response
#### Success Response (200)
- **200** - Successful retrieval of the signed template details.

#### Error Response (400)
- **400** - Bad request.
```

--------------------------------

### GET /v3/me/signed/{signed_id}/download

Source: https://docs.signeasy.com/reference/download-self-signed-document

Download the self signed document as PDF using the signed_id.

```APIDOC
## GET /v3/me/signed/{signed_id}/download

### Description
Download the self signed document as PDF using the signed_id.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/me/signed/{signed_id}/download

### Parameters
#### Path Parameters
- **signed_id** (int32) - Required - The unique identifier of the signed document.

### Response
#### Success Response (200)
- Returns the document as a PDF file.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized (Returned if the user lacks access or the file does not exist)
```

--------------------------------

### Create Envelope with Templates

Source: https://docs.signeasy.com/docs/embedded-signing

Initiates an envelope request using template sources, including role mapping and merge fields for embedded signing.

```bash
curl --location --request POST 'https://api.signeasy.com/v3/rs/envelope/' \
--header 'Authorization: Bearer **{{access_token}}**' \
--header 'Content-Type: application/json' \
--data-raw '{
    "embedded_signing": true,
    "sources": [{
        "source_id": 1,
        "type": "template",
        "id": 4228166
    },{
        "source_id": 2,
        "type": "template",
        "id": 4238638
    }],
    "is_ordered": 0,
    "recipients": [{
        "first_name": "john",
        "last_name": "doe",
        "email": "john.doe@signeasy.com",
        "recipient_id": 1
    },{
        "first_name": "jacob",
        "last_name": "Doe",
        "email": "jacob@signeasy.com",
        "recipient_id": 2
    }],
    "message": "Envelope API Demo with 2 Templates",
    "recipient_role_mapping": [{
        "role_id": 1,
        "recipient_id": 1,
        "source_id": 1
    },
    {
        "role_id": 2,
        "recipient_id": 2,
        "source_id": 1
    }],
     "merge_fields": [
        {
            "label": "mergeLabel1",
            "value": "John",
            "source_id": 1
        },
        {
            "label": "mergeLabel2",
            "value": "Jacob",
            "source_id": 2
        }
    ],
    "fields_payload": [
        {
            "recipient_id": 1,
            "source_id": 1,
            "type": "signature",
            "required": true,
            "page_number": 1,

            "position": {
                "text": "signeasy",
                "height": 50,
                "width": 50,
                "mode": "referenceText"
            },
    "additional_info": {}
        },
         {
            "recipient_id": 2,
            "source_id": 2,
            "type": "signature",
            "required": true,
            "page_number": "all",

            "position": {
                "x": 200,
                "y": 300,
                "height": 50,
                "width": 50,
                "mode": "fixed"
            },
    "additional_info": {}
        }
    ],
    "signature_panel_types": ["draw"]
}'
```

--------------------------------

### Successful Response Example

Source: https://docs.signeasy.com/reference/list-signed-documents

Represents a successful API response containing a list of signed files with their metadata and recipient details.

```json
{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": null,
            "checksum": "37d1a91062553e4602880e675c4d1f9d1c1f407e084c9d7866d2b3b8b248f174",
            "created_time": 1557731017,
            "fa_aadhaar_enabled": null,
            "id": 14845678,
            "last_modified_time": 1557731017,
            "name": "Employment Agreement - Prashanth.pdf",
            "pending_file": {
                "created_time": 1557730913,
                "has_markers": 0,
                "id": 235696,
                "is_in_person": 0,
                "is_ordered": 0,
                "last_modified_time": 1557731018,
                "name": "Employment Agreement - Prashanth.pdf",
                "next": 378028,
                "owner_company": null,
                "owner_email": "spatro@signeasy.com",
                "owner_first_name": "Sunil",
                "owner_last_name": "Patro Ek",
                "recipients": [
                    {
                        "created_time": 1557730915,
                        "email": "prashanth.signeasy@gmail.com",
                        "first_name": "Prashanth",
                        "last_modified_time": 1557730975,
                        "last_name": "Raghu",
                        "order_id": 1,
                        "recipient_id": 378028,
                        "recipient_user_id": 3625901,
                        "status": "finalized"
                    },
                    {
                        "created_time": 1557730916,
                        "email": "jiril.joseph@signeasy.com",
                        "first_name": "Jiril",
                        "last_modified_time": 1557731014,
                        "last_name": "Joseph",
                        "order_id": 2,
                        "recipient_id": 378029,
                        "recipient_user_id": 3626367,
                        "status": "finalized"
                    }
                ],
                "status": "complete"
            },
            "public_identifier": "pNovCTn7_nQ5imZW6_Nhgw=="
        },
        {
            "aadhaar_enabled": null,
            "checksum": "e3c10aa1faf10d6feab10f348790bcda1fbb4f0ba2a1151f8a9d92e3fc263d14",
            "created_time": 1557731210,
            "fa_aadhaar_enabled": null,
            "id": 14845680,
            "last_modified_time": 1557731210,
            "name": "Employment Agreement - Anirjit.pdf",
            "pending_file": {
                "created_time": 1557731135,
                "has_markers": 0,
                "id": 235699,
                "is_in_person": 0,
                "is_ordered": 1,
                "last_modified_time": 1557731210,
                "name": "Employment Agreement - Anirjit.pdf",
                "next": 378035,
                "owner_company": null,
                "owner_email": "spatro@signeasy.com",
                "owner_first_name": "Sunil",
                "owner_last_name": "Patro Ek",
                "recipients": [
                    {
                        "created_time": 1557731136,
                        "email": "anirjit@gmail.com",
                        "first_name": "Anirjit",
                        "last_modified_time": 1557731167,
                        "last_name": "Bakshi",
                        "order_id": 1,
                        "recipient_id": 378034,
                        "recipient_user_id": 3625901,
                        "status": "finalized"
                    },
                    {
                        "created_time": 1557731137,
                        "email": "jiril.joseph@signeasy.com",
                        "first_name": "Jiril",
                        "last_modified_time": 1557731208,
                        "last_name": "Joseph",
                        "order_id": 2,
                        "recipient_id": 378035,
                        "recipient_user_id": 3626367,
                        "status": "finalized"
                    }
                ],
                "status": "complete"
            },
            "public_identifier": "ip_dRR0POvdI9cQgwbPqcg=="
        }
 ]
```

--------------------------------

### GET /envelopes/signed-documents

Source: https://docs.signeasy.com/reference/list-envelope-signed-documents

Retrieves a list of signed documents.

```APIDOC
## GET /envelopes/signed-documents

### Description
Retrieves a list of signed documents associated with envelopes.

### Method
GET

### Response
#### Success Response (200)
- **count** (integer) - The total number of files returned.
- **files** (array) - A list of file objects.

#### Response Example
{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": 0,
            "checksum": "70f9f896f4034d242cb3ff9268c8417a60a84f5d0ae07a9dedb75a6a22500a7a",
            "created_time": 1574852499,
            "fa_aadhaar_enabled": null,
            "id": 14862799,
            "last_modified_time": 1574852499,
            "name": "Employment Agreement - Prashanth Raghu.pdf",
            "pending_file": {
                "created_time": 1574852276,
                "envelope_size": 2,
                "has_markers": 1,
                "id": 1000192,
                "is_envelope": 1,
                "is_in_person": 0,
                "is_ordered": 0,
                "last_modified_time": 1574852504,
                "name": "Employment Agreement - Prashanth Raghu.pdf",
                "next": 384952,
                "owner_company": "",
                "owner_email": "spatro@signeasy.com",
                "owner_first_name": "Sunil",
                "owner_last_name": "Patro Ek",
                "recipients": [
                    {
                        "created_time": 1574852387,
                        "email": "prashanth.raghu@signeasy.com",
                        "first_name": "Prashanth Raghu",
                        "last_modified_time": 1574852497,
                        "last_name": "",
                        "order_id": 1,
                        "recipient_id": 384951,
                        "recipient_user_id": 3626367,
                        "status": "finalized"
                    },
                    {
                        "created_time": 1574852388,
                        "email": "jiril.joseph@signeasy.com",
                        "first_name": "Jiril Joseph",
                        "last_modified_time": 1574852435,
                        "last_name": "",
                        "order_id": 2,
                        "recipient_id": 384952,
                        "recipient_user_id": 3625901,
                        "status": "finalized"
                    }
                ],
                "status": "complete"
            },
            "public_identifier": "pHkDiFc8I+D1MZnUO6i7mg=="
        }
    ]
}
```

--------------------------------

### Template API Response Example

Source: https://docs.signeasy.com/reference/update-template

Represents a successful 200 OK response containing the full template object details including metadata, fields, and merge fields.

```json
{
    "group_info": null,
    "id": 24255,
    "owner_user_id": 3675808,
    "name": "Sample Template Name",
    "metadata": {
        "roles": [
            {
                "id": 1,
                "name": "One",
                "color": "rgba(78, 116, 243, 0.2)"
            }
        ],
        "fields": [
            {
                "id": 1,
                "type": "signature",
                "sub_type": null,
                "additional_info": null,
                "required": true,
                "editable": null,
                "role_id": 1,
                "group_id": null,
                "page_number": 1,
                "position": {
                    "x": 113.369565,
                    "y": 690.322464,
                    "width": 70.0,
                    "height": 20.0,
                    "mode": null
                }
            }
        ],
        "merge_fields": [
            {
                "id": 2,
                "type": "text",
                "sub_type": null,
                "additional_info": {
                    "label": "Merge label",
                    "merge_field": true
                },
                "required": true,
                "editable": null,
                "group_id": null,
                "page_number": 1,
                "position": {
                    "x": 333.09058,
                    "y": 626.619565,
                    "width": 176.0,
                    "height": 20.0,
                    "mode": "fixed"
                }
            }
        ]
    },
    "message": "This is a test message.",
    "is_ordered": false,
    "created_time": 1700460896.0,
    "modified_time": 1700468998.0,
    "is_shared": false,
    "is_owned": true,
    "attributes": null,
    "file_status": "READY_TO_USE",
    "is_shared_with_everyone": false,
    "file_content_type": "application/pdf"
}
```

--------------------------------

### Retrieve Signing URL Response

Source: https://docs.signeasy.com/reference/fetch-rs-sending-url

Example of a successful JSON response containing the file_id and the generated signing URL.

```json
{
    "file_id": "23187514",
    "url": "https://app.signeasy.com/#/embedded-signing?hash=5281d4152d364c78abbba8271f8332ebf64c53e15a0f4c5c96ce4b87b111b71e&file_id=23187514&version=1&type=rs&data=eyJjYyI6IG51bGwsICJtZXNzYWdlIjogIlNhbXBsZSBTZWxmIFNpZ24tMjEzIiwgInJlY2lwaWVudHMiOiBudWxsfQ=="
}
```

--------------------------------

### GET /rs/signed

Source: https://docs.signeasy.com/reference/list-signed-documents

Retrieves a list of all signed envelopes associated with the account.

```APIDOC
## GET /rs/signed

### Description
Fetch all signed envelopes from the Signeasy API.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/rs/signed

### Response
#### Success Response (200)
- **Result** (object) - A list of signed envelopes.
```

--------------------------------

### GET /rs/envelope/{pending_file_id}

Source: https://docs.signeasy.com/reference/fetch-envelope-rs-details

Retrieves information about a pending envelope by its ID.

```APIDOC
## GET /rs/envelope/{pending_file_id}

### Description
Retrieve information about a pending envelope with the `id` returned from the create or send an envelope endpoint. This endpoint returns a response irrespective of whether the envelope's `status` is `complete`, `incomplete`, `canceled` or `recipient_declined`.

### Method
GET

### Endpoint
https://api.signeasy.com/v3/rs/envelope/{pending_file_id}

### Parameters
#### Path Parameters
- **pending_file_id** (integer) - Required - The id returned back from the API request when an envelope is sent out for signature.

### Response
#### Success Response (200)
- **id** (integer) - Envelope ID
- **owner_user_id** (integer) - ID of the owner
- **status** (string) - Current status of the envelope
- **created_time** (integer) - Timestamp of creation
- **last_modified_time** (integer) - Timestamp of last modification
- **owner_email** (string) - Email of the owner
- **recipients** (array) - List of recipients associated with the envelope

#### Response Example
{
  "id": 200000001,
  "owner_user_id": 500000,
  "status": "incomplete",
  "created_time": 1783517834,
  "owner_email": "owner@example.com"
}
```

--------------------------------

### POST /original/

Source: https://docs.signeasy.com/reference/create-an-original-document

Uploads a new document as an original to Signeasy. The file can be gzip compressed, in which case the Content-Encoding header must be set to gzip.

```APIDOC
## POST /original/

### Description
Upload a new document as an original to Signeasy to use it for signing via the envelope APIs.

### Method
POST

### Endpoint
https://api.signeasy.com/v3/original/

### Parameters
#### Request Body
- **file** (binary) - Required - The file object of the source document. The maximum file size per document is 25 MB. Please use multipart form upload. Base64 upload is not supported.
- **name** (string) - Required - The name with the correct extension of the source document. Characters `/, :, *, \, <, >, |` are not allowed.
- **rename_if_exists** (boolean) - Required - If set to true and a document with the same name exists, the current file will be renamed.

### Response
#### Success Response (200)
- **created_time** (integer) - The timestamp when the document was created.
- **id** (integer) - The unique identifier of the document.
- **last_modified_time** (integer) - The timestamp when the document was last modified.
- **name** (string) - The name of the uploaded document.

#### Response Example
{
    "created_time": 1590751553,
    "id": 23188790,
    "last_modified_time": 1590751553,
    "name": "IT Contract - Employee (Jane Doe).pdf"
}
```

--------------------------------

### Fetch all templates via cURL

Source: https://docs.signeasy.com/reference/list-templates

Use this request to retrieve a list of all templates. Ensure the request includes the appropriate Bearer token for authentication.

```Shell
curl --request GET \
     --url https://api.signeasy.com/v3/template \
     --header 'accept: application/json'
```

--------------------------------

### GET /original/{original_id}/

Source: https://docs.signeasy.com/reference/fetch-details-of-an-original

Retrieve information about a specific original document.

```APIDOC
## GET /original/{original_id}/

### Description
Retrieve information about a specific original document.

### Method
GET

### Endpoint
/original/{original_id}/

### Parameters
#### Path Parameters
- **original_id** (integer) - Required - The unique identifier of the original document.

### Response
#### Success Response (200)
- **created_time** (integer) - The timestamp when the document was created.
- **id** (integer) - The unique identifier of the document.
- **last_modified_time** (integer) - The timestamp when the document was last modified.
- **name** (string) - The name of the document.

#### Response Example
{
  "created_time": 1590751553,
  "id": 23188790,
  "last_modified_time": 1590751553,
  "name": "IT Contract - Employee (Jane Doe).pdf"
}
```

--------------------------------

### POST /template/

Source: https://docs.signeasy.com/reference/upload-a-template

Uploads a document to be processed as a template.

```APIDOC
## POST /template/

### Description
Uploads a document to Signeasy and initializes it as a template. The maximum file size is 25 MB.

### Method
POST

### Endpoint
https://api.signeasy.com/v3/template/

### Parameters
#### Request Body
- **file** (binary) - Required - The file object of the source document. Use Content-Encoding: gzip for compressed files.
- **name** (string) - Required - The name of the source document with the correct extension. Special characters like /, :, *, \, <, >, | are not allowed.
- **rename_if_exists** (boolean) - Required - If true, renames the file if a document with the same name already exists.

### Request Example
{
  "file": "[binary_data]",
  "name": "your-file-name.pdf",
  "rename_if_exists": true
}

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the template.
- **name** (string) - The name of the template.
- **file_status** (string) - The processing status of the file.
- **created_time** (integer) - Timestamp of creation.

#### Response Example
{
    "id": 24255,
    "name": "Sample Template Name",
    "file_status": "PROCESSED",
    "created_time": 1700460895.0
}
```

--------------------------------

### Create Envelope with Original Documents

Source: https://docs.signeasy.com/docs/embedded-signing

Initiates an envelope request using original document sources with embedded signing enabled.

```bash
curl --location --request POST 'https://api.signeasy.com/v3/rs/envelope/' \
--header 'Authorization: Bearer **{{access_token}}**' \
--header 'Content-Type: application/json' \
--data-raw '{
    "embedded_signing": true,
    "sources": [{
        "source_id": 1,
        "type": "original",
        "id": 55590502
    },{
        "source_id": 2,
        "type": "original",
        "id": 50004293
    }],
    "is_ordered": 0,
    "recipients": [{
        "first_name": "john",
        "last_name": "doe",
        "email": "john.doe@signeasy.com",
        "recipient_id": 1
    },{
        "first_name": "jacob",
        "last_name": "Doe",
        "email": "jacob@signeasy.com",
        "recipient_id": 2
    }],
    "message": "Envelope API Demo with 2 Originals",
    "fields_payload": [
        {
            "recipient_id": 1,
            "source_id": 1,
            "type": "signature",
            "required": true,
            "page_number": 1,

            "position": {
                "text": "signeasy",
                "height": 50,
                "width": 50,
                "mode": "referenceText"
            },
    "additional_info": {}
        },
         {
            "recipient_id": 2,
            "source_id": 2,
            "type": "signature",
            "required": true,
            "page_number": "all",

            "position": {
                "x": 200,
                "y": 300,
                "height": 50,
                "width": 50,
                "mode": "fixed"
            },
    "additional_info": {}
        }
    ],
    "signature_panel_types": ["draw"]
}'
```

--------------------------------

### GET /rs/signed/{signed_id}/download

Source: https://docs.signeasy.com/reference/download-signed-document-pdf

Downloads a signed envelope document.

```APIDOC
## GET /rs/signed/{signed_id}/download

### Description
Downloads a signed envelope document.

### Method
GET

### Endpoint
/rs/signed/{signed_id}/download

### Parameters
#### Path Parameters
- **signed_id** (integer) - Required - The unique identifier of the signed envelope.

### Response
#### Success Response (200)
- **PDF Content** (binary) - The content of the signed document in PDF format.

#### Response Example
"PDF Content"
```
Tokens:
Raw