iinked Sign by Syngrafii

https://docs.iinkedsign.com
Admin
iinked Sign by Syngrafii is a secure, scalable electronic signature platform with RESTful API...
Tokens:207,457
Snippets:771
Trust Score:6.6
Update:7 months ago
Show doc for...
Tokens:
Raw
### Create Package Request (HTTP)

Source: https://docs.iinkedsign.com/v4/quickstart

Example of an HTTP POST request to the /packages/add endpoint to create a new signing package. It specifies package details, signers, and documents. For production, it's recommended to use file uploads via the Files upload API.

```http
POST /packages/add
{
  "name": "My First Package",
  "signers": [
    {
      "firstName": "{{first_name}}",
      "lastName": "{{last_name}}",
      "email": "{{email}}"
    }
  ],
  "documents": [
    {
      "fileName": "agreement.pdf",
      "fileUrl": "{{file_url}}"
    }
  ]
}
```

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

### Retrieve Template Field Data after Package Finalization

Source: https://docs.iinkedsign.com/v4/guides/template-data

This example shows the HTTP GET request to retrieve data for all fields within a finalized package. The response is a JSON object containing package details and an array of documents, each with an array of field data including `dataId` and `value`.

```http
GET /packages/{package_id}/data
```

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

### Second Signer Checkbox Group Example

Source: https://docs.iinkedsign.com/v4/guides/template-tagging/tags

An example of setting up checkbox groups for a second signer, demonstrating distinct group IDs for different signers. This allows for independent checkbox management per signer.

```handlebars
{{signer_2:checkbox_2}}
{{checkbox_2.1}}
{{checkbox_2.2}}
{{checkbox_2.3}}

```

```handlebars
{{s_2:c_2}}
{{c_2.1}}
{{c_2.2}}
{{c_2.3}}

```

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

### Package Creation and Configuration

Source: https://docs.iinkedsign.com/v4/api/packages/get

This section details the parameters available when creating or updating a signing package, allowing for customization of the signing experience.

```APIDOC
## POST /websites/iinkedsign

### Description
Create and configure a new signing package with various customization options.

### Method
POST

### Endpoint
/websites/iinkedsign

### Parameters
#### Request Body
- **returnUrl** (string) - Required - The URL to redirect the user to after they complete the signing process.
- **returnState** (string) - Optional - A value that will be included in the `state` query parameter appended to the `returnUrl`.
- **brandId** (string) - Optional - Specifies a custom brand to be displayed when signing the package. (Available since 1.10)
- **addDocumentIdentifier** (boolean) - Optional - If true, adds a document identifier (QR code) to each page.
- **allowReview** (boolean) - Optional - If true, allows VSR participants to review documents before a meeting via a "Review Documents" link in the email invitation. (Available since 2.6)
- **allowForwardSignings** (boolean) - Optional - If true, allows signers to forward the signing request to another email address. (Available since 4.0)
- **enhancedPrivacy** (boolean) - Optional - If true, enables enhanced privacy by not sharing email addresses between signers. Supported in Concurrent, Sequential, and Group Send package types. (Available since 2.11)
- **formDisabled** (boolean) - Optional - If true, prevents signers from filling AcroForm fields during signing. (Available since 3.3)
- **formReadOnly** (boolean) - Optional - If true, prevents signers from modifying AcroForm fields during signing. (Available since 3.6)
- **formFlattening** (string) - Optional - Controls how AcroForm fields are flattened after signing. Possible values: `none`, `filled`, `all` (default). (Available since 2.6)
- **styleInkColor** (string) - Optional - Overrides the default ink color for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value. (Available since 2.10)
- **defaultMark** (string) - Optional - Sets the preferred default mark type. Possible values: `touch_to_sign`, `type_to_sign`, `click_to_sign`. (Available since 4.0)
- **retentionPeriod** (string) - Optional - Adds a retention period to the package to prevent deletion (ISO 8601 duration format). (Available since 1.11)
- **templateParseTags** (boolean) - Optional - If true, parses the document for templating tags. Defaults to true.
- **templateParseMergeDataTags** (boolean) - Optional - If true, parses for merger data templating tags. Defaults to false. (Available since 4.0)
- **templateUnusedSignerTags** (string) - Optional - Controls how unused signer tags are handled. Possible values: `keep`, `hide`, `remove` (default). (Available since 2.6)
- **cac** (string) - Optional - Controls which document(s) within a package have the CAC page appended to them. Possible values: `document_all`, `document_first`, `document_last`. (Available since 3.2)
- **cacSignerIdentification** (boolean) - Optional - Enables CAC signer identification.

### Request Example
```json
{
  "returnUrl": "https://example.com/return",
  "brandId": "my-custom-brand",
  "allowReview": true,
  "enhancedPrivacy": true,
  "formFlattening": "filled"
}
```

### Response
#### Success Response (200)
- **packageId** (string) - The unique identifier for the created package.
- **status** (string) - The status of the package creation.

#### Response Example
```json
{
  "packageId": "pkg_abc123xyz",
  "status": "created"
}
```
```

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

### HTTP GET Request to View Verification Results

Source: https://docs.iinkedsign.com/v4/api/verifications/view

This is an example of an HTTP GET request to the iinkedsign API to retrieve detailed verification results. The request requires a `verificationId` as a path parameter.

```http
GET /verifications/{verificationId}/view
```

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

### POST /api/v1/packages/add

Source: https://docs.iinkedsign.com/v4/quickstart

This endpoint allows you to create a new package and initiate the signing process by providing package details, signer information, and document references.

```APIDOC
## POST /api/v1/packages/add

### Description
Creates a new package for signing, including details about the package, signers, and documents.

### Method
POST

### Endpoint
https://sandbox.syngrafii.com/api/v1/packages/add

### Parameters
#### Header Parameters
- **api_key** (string) - Required - Your unique API key for authentication.

#### Request Body
- **name** (string) - Required - The name of the package.
- **signers** (array) - Required - A list of objects, where each object contains signer details:
  - **firstName** (string) - Required - The first name of the signer.
  - **lastName** (string) - Required - The last name of the signer.
  - **email** (string) - Required - The email address of the signer.
- **documents** (array) - Required - A list of objects, where each object contains document details:
  - **fileName** (string) - Required - The name of the document file.
  - **fileUrl** (string) - Required - The URL of the document file. (Note: For production, using `fileId` from the Files upload API is recommended).

### Request Example
```json
{
  "name": "My First Package",
  "signers": [
    {
      "firstName": "{{first_name}}",
      "lastName": "{{last_name}}",
      "email": "{{email}}"
    }
  ],
  "documents": [
    {
      "fileName": "agreement.pdf",
      "fileUrl": "{{file_url}}"
    }
  ]
}
```

### Response
#### Success Response (200)
(Response structure not detailed in the provided text, but typically includes a package ID and status.)

#### Response Example
(Example response not provided in the source text.)
```

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

### GET /packages/{packageId}/signers/{signerId}/verification

Source: https://docs.iinkedsign.com/v4/api/verifications/signer

Fetches the verification results for a specific signer. If the signer has not started identity verification, the `verificationId` will be an empty UUID and the state will be `not_started`.

```APIDOC
## GET /packages/{packageId}/signers/{signerId}/verification

### Description
Retrieves detailed verification results for a signer within a package. Returns an empty UUID and `not_started` status if verification has not begun.

### Method
GET

### Endpoint
`/packages/{packageId}/signers/{signerId}/verification`

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The unique identifier of the package the signer belongs to.
- **signerId** (string) - Required - The unique identifier of the signer to retrieve verification results for.

### Request Example
```http
GET /packages/pkg_123/signers/signer_abc/verification
```

### Response
#### Success Response (200)
- **verificationId** (string) - The unique identifier for the verification process.
- **status** (string) - The current status of the verification (e.g., `not_started`, `in_progress`, `completed`, `failed`).

#### Response Example
```json
{
  "verificationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "completed"
}
```

#### Response Example (Not Started)
```json
{
  "verificationId": "00000000-0000-0000-0000-000000000000",
  "status": "not_started"
}
```
```

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

### Package Creation and Configuration

Source: https://docs.iinkedsign.com/v4/reference/packages/package

This section details the parameters available when creating or configuring a signing package.

```APIDOC
## POST /websites/iinkedsign

### Description
This endpoint allows for the creation and configuration of signing packages with a wide range of options to customize the signing experience.

### Method
POST

### Endpoint
/websites/iinkedsign

### Parameters
#### Request Body
- **returnUrl** (string) - Required - The URL to redirect the user back to after they have finished editing the package.
- **returnState** (string) - Optional - Will be included in a `state` query string parameter appended to the `returnUrl`.
- **brandId** (string) - Optional - Show custom brand when signing package. (Available from v1.10)
- **addDocumentIdentifier** (boolean) - Optional - Add document identifier to each page (QR code).
- **allowReview** (boolean) - Optional - Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation. (Available from v2.6)
- **allowForwardSignings** (boolean) - Optional - Allow signers to forward the signing to another email address. (Available from v4.0)
- **enhancedPrivacy** (boolean) - Optional - Enabled to not share email addresses between signers. (Available from v2.11). Supported in Concurrent, Sequential, and Group Send package types.
- **formDisabled** (boolean) - Optional - Do not allow signers to fill AcroForm fields during signing. (Available from v3.3)
- **formReadOnly** (boolean) - Optional - Do not allow signers to modify AcroForm fields during signing. (Available from v3.6)
- **formFlattening** (string) - Optional - Control how Acroform fields are flattened after signing a document. (Available from v2.6). Possible values: `none` (Do not flatten fields), `filled` (Flatten only fields filled by signer), `all` (Flatten all fields, `default`).
- **styleInkColor** (string) - Optional - Override the default ink color `#0000FF` for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value. (Available from v2.10)
- **defaultMark** (string) - Optional - Set preferred default mark type. (Available from v4.0). Possible values: `touch_to_sign` (iink It), `type_to_sign` (Type It), `click_to_sign` (Accept It).
- **retentionPeriod** (string) - Optional - Add a retention period to the package to prevent deletion. (ISO 8601 duration) (Available from v1.11)
- **templateParseTags** (boolean) - Optional - Parse document for templating tags. Defaults to true.
- **templateParseMergeDataTags** (boolean) - Optional - Parse merger data templating tags. Defaults to false. (Available from v4.0)
- **templateUnusedSignerTags** (string) - Optional - Control how unused signer tags are handled. (Available from v2.6). Possible values: `keep` (Leave unused tags in document), `hide` (Move unused tags to hidden layer), `remove` (Remove unused tags, `default`).
- **cac** (string) - Optional - Control which document(s) within a package have the CAC page appended to them. (Available from v3.2). Possible values: `document_all` (Append to all documents in package), `document_first` (Append to first document in package), `document_last` (Append to last document in package).
- **cacSignerIdentification** (boolean) - Optional - Enable CAC signer identification.

### Request Example
```json
{
  "returnUrl": "https://example.com/return",
  "brandId": "my-custom-brand",
  "allowReview": true,
  "enhancedPrivacy": true,
  "formFlattening": "filled"
}
```

### Response
#### Success Response (200)
- **packageId** (string) - The unique identifier for the created package.
- **status** (string) - The current status of the package.

#### Response Example
```json
{
  "packageId": "pkg_abcdef123456",
  "status": "created"
}
```
```

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

### Pre-populate Template Fields in Signing Package Request

Source: https://docs.iinkedsign.com/v4/guides/template-data

This HTTP request example shows how to pre-populate template fields when adding or updating a signing package. The `templateData` object within each document maps data IDs to their desired values. This requires prior identification of template fields.

```http
POST /packages/add
{
    "type": "concurrent",
    "state": "open",
    "name": "From Template with Data",
    "templateId": "{{template_id}}",
    "signers": [
        {
            "templateRole": "Signer 1",
            "firstName": "Signer",
            "lastName": "One",
            "email": "{{signer_1_email}}",
            "mobileNumber": null
        }
    ],
    "recipients": [
        {
            "templateRole": "Recipient 1",
            "firstName": "Recipient",
            "lastName": "One",
            "email": "{{recipient_1_email}}",
            "mobileNumber": null
        }
    ],
    "documents": [
        {
            "templateDocumentId": "{{template_document_1_id}}",
            "templateData": {
                "text1": "Set Text Field Value",
                "multiline1": "Set Multiline Field Value Line 1\nSet Multiline Field Value Line 2"
            }
        }
    ]
}
```

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

### Create Video Signing Room Package

Source: https://docs.iinkedsign.com/v4/api

This snippet illustrates creating a package for a 'video_closing_room' type. It includes a meeting schedule with start time and duration, and specifies roles for signers (host and signer). Templating tags for host and signers are also mentioned.

```json
POST /packages/add
{
    "name": "New Package",
    "type": "video_closing_room",
    "meeting": {
        "timeStart": "2024-12-01T15:00:00Z",
        "duration": "PT1H"
    },
    "signers": [
        {
            "firstName": "Host",
            "lastName": "One",
            "email": "host.one@example.com",
            "role": "host"
        },
        {
            "firstName": "Signer",
            "lastName": "One",
            "email": "signer.one@example.com",
            "role": "signer"
        }
        {
            "firstName": "Signer",
            "lastName": "Two",
            "email": "signer.two@example.com",
            "role": "signer"
        }
    ],
    "documents": [
        {
            "fileName": "agreement.pdf",
            "fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
        }
    ]
}
```

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

### Fetch Signer Verification Results (HTTP)

Source: https://docs.iinkedsign.com/v4/api/verifications/signer

This snippet shows how to make an HTTP GET request to retrieve the verification results for a specific signer within a package. It requires the packageId and signerId as path parameters. The response will contain verification details, or indicate if verification has not started.

```http
GET /packages/{packageId}/signers/{signerId}/verification
```

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

### GET /packages/{packageId}

Source: https://docs.iinkedsign.com/v4/api/packages/get

Retrieves detailed information about a specific package using its unique identifier.

```APIDOC
## GET /packages/{packageId}

### Description
Retrieves detailed information about a specific package by its unique identifier.

### Method
GET

### Endpoint
/packages/{packageId}

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The unique identifier of the package you want to retrieve.

### Response
#### Success Response (200)
- **[Fields will be documented here based on the actual response structure]**

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Create In Person Signing Package

Source: https://docs.iinkedsign.com/v4/api

This snippet demonstrates creating a package for 'Live Session' (In Person) signing. It requires specifying a host signer who will receive the notification. The package includes signers' details and document information.

```json
POST /packages/add
{
    "name": "New Package",
    "type": "Live Session",
    "signers": [
        {
            "firstName": "Signer",
            "lastName": "Host",
            "email": "signer.host@example.com",
            "role": "host"
        },
        {
            "firstName": "Signer",
            "lastName": "One",
            "email": "signer.one@example.com"
        }
        {
            "firstName": "Signer",
            "lastName": "Two",
            "email": "signer.two@example.com"
        }
    ],
    "documents": [
        {
            "fileName": "agreement.pdf",
            "fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
        }
    ]
}
```

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

### HTTP GET Request for MasterFile

Source: https://docs.iinkedsign.com/v4/api/masterfile/get

This snippet shows the HTTP GET request to retrieve the MasterFile object for a specific package. The 'packageId' parameter is a required string that uniquely identifies the package. Direct parsing of the MasterFile JSON is not recommended due to its complexity and potential for change.

```http
GET /masterfiles/{packageId}
```

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

### POST /packages/add

Source: https://docs.iinkedsign.com/v4/guides/sign

Creates a new signing package. Requires package details, signer information, and the fileId of the document(s) to be signed.

```APIDOC
## POST /packages/add

### Description
Creates a new signing package. Requires package details, signer information, and the fileId of the document(s) to be signed.

### Method
POST

### Endpoint
/packages/add

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the signing package.
- **timeSignBy** (string) - Optional - The deadline for signing the documents (ISO 8601 format).
- **type** (string) - Required - The type of the package (e.g., 'concurrent').
- **signers** (array) - Required - A list of signer objects, each containing firstName, lastName, and email.
- **documents** (array) - Required - A list of document objects, each containing fileName and fileId.
- **returnPackage** (boolean) - Optional - Whether to return the full package details.

### Request Example
```json
{
    "name": "New Package",
    "timeSignBy": "2025-12-31T23:59:59Z",
    "type": "concurrent",
    "signers": [
        {
            "firstName": "Signer",
            "lastName": "One",
            "email": "signer.one@example.com"
        }
    ],
    "documents": [
        {
            "fileName": "document.pdf",
            "fileId": "51400d7a-4f34-4844-9138-46a365130f97"
        }
    ],
    "returnPackage": false
}
```

### Response
#### Success Response (200)
- **packageId** (string) - The unique identifier for the created package.
- **package** (object) - Can be null or contain package details if `returnPackage` is true.

#### Response Example
```json
{
    "packageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "package": null
}
```
```

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

### POST /events/endpoints/set

Source: https://docs.iinkedsign.com/v4/webhooks/setup

Register, update, or delete a webhook endpoint for receiving real-time event notifications. This endpoint can be used to automate webhook setup via the API.

```APIDOC
## POST /events/endpoints/set

### Description
Register, update, or delete a webhook endpoint for receiving real-time event notifications. This endpoint can be used to automate webhook setup via the API.

### Method
POST

### Endpoint
/events/endpoints/set

### Parameters
#### Query Parameters
None

#### Request Body
- **url** (string) - Required - The publicly accessible URL of your webhook endpoint. It must use HTTPS and have a valid SSL certificate.
- **name** (string) - Optional - A friendly name for your webhook endpoint.
- **delete** (boolean) - Optional - Set to true to delete the specified webhook endpoint.

### Request Example
```json
{
    "url": "https://example.com/your-webhook-endpoint"
}
```

### Response
#### Success Response (200)
- **endpoint** (object) - Details of the registered webhook endpoint.
  - **eventEndpointId** (string) - Unique identifier for the webhook endpoint.
  - **name** (string) - Friendly name for the webhook endpoint.
  - **url** (string) - The URL of the webhook endpoint.
  - **secret** (string) - The secret token used for authenticating webhook requests.

#### Response Example
```json
{
    "endpoint": {
        "eventEndpointId": "e7b8f9c2-3d4a-4b5c-8e9f-1a2b3c4d5e6f",
        "name": "My Webhook Endpoint",
        "url": "https://example.com/your-webhook-endpoint",
        "secret": "your-secret-token"
    }
}
```
```

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

### POST /packages/add

Source: https://docs.iinkedsign.com/v4/guides/embed-signing

Creates a new signing package. Set `generateSignerLinks` to true and `options.embedded` to true to prepare for embedded signing. The response will contain a `signLink.link` which can be used to embed the signing experience.

```APIDOC
## POST /packages/add

### Description
Creates a new signing package for embedded signing.

### Method
POST

### Endpoint
/packages/add

### Parameters
#### Request Body
- **name** (string) - Required - The name of the package.
- **type** (string) - Required - The type of package (e.g., "concurrent").
- **state** (string) - Required - The initial state of the package (e.g., "open").
- **generateSignerLinks** (boolean) - Required - Set to `true` to generate signer links for embedding.
- **options** (object) - Required - Options for the package.
  - **embedded** (boolean) - Required - Set to `true` to enable embedded signing.
- **signers** (array) - Required - An array of signer objects.
  - **firstName** (string) - Required - The first name of the signer.
  - **lastName** (string) - Required - The last name of the signer.
  - **email** (string) - Required - The email address of the signer.
- **documents** (array) - Required - An array of document objects.
  - **fileName** (string) - Required - The name of the document file.
  - **fileId** (string) - Required - The ID of the document.

### Request Example
```json
{
    "name": "Embedded Package Signing",
    "type": "concurrent",
    "state": "open",
    "generateSignerLinks": true,
    "options": {
        "embedded": true
    },
    "signers": [
        {
            "firstName": "signer",
            "lastName": "one",
            "email": "signer.one@example.com"
        }
    ],
    "documents": [
        {
            "fileName": "document.pdf",
            "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
        }
    ]
}
```

### Response
#### Success Response (200)
- **package** (object) - The created package object.
  - **signers** (array) - The array of signers.
    - **signLink** (object) - Information about the signer link.
      - **link** (string) - The URL to embed for signing.

#### Response Example
```json
{
    "package": {
        "signers": [
            {
                 "signLink": {
                     "link": "https://sign.syngrafii.com/link/mzLzlN5zECs2SlS_VJ-njg"
                 }
            }
        ]
    }
}
```
```

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

### GET /masterfiles/{packageId}

Source: https://docs.iinkedsign.com/v4/api/masterfile/get

Fetches the complete MasterFile object for a given package ID. Note: Parsing the MasterFile JSON is not recommended due to its complexity and potential for change.

```APIDOC
## GET /masterfiles/{packageId}

### Description
Fetches the complete MasterFile object for a specified package ID. The structure of the MasterFile is complex and may change, so direct parsing is discouraged.

### Method
GET

### Endpoint
/masterfiles/{packageId}

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The unique identifier of the package you want to download MasterFile for.

### Response
#### Success Response (200)
- **MasterFile object** - The complete MasterFile object for the requested package.

#### Response Example
{
  "example": "[MasterFile JSON object structure]"
}
```

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

### Package Creation and Configuration

Source: https://docs.iinkedsign.com/v4/api/packages/get

This section details the parameters available when creating or updating a signing package, including security settings, identity verification, and reminder options.

```APIDOC
## POST /websites/iinkedsign

### Description
Creates a new signing package with specified configurations.

### Method
POST

### Endpoint
/websites/iinkedsign

### Parameters
#### Request Body
- **allowModifyAnnotations** (boolean) - Optional - Allow PDF annotations.
- **allowModifyContents** (boolean) - Optional - Allow PDF editing.
- **allowPrinting** (boolean) - Optional - Allow PDF printing.
- **allowScreenReaders** (boolean) - Optional - Allow screen readers.
- **verificationOptions** (object) - Optional - Set identity verification options.
  - **policyId** (string) - Optional - The policy ID of the custom Identity Verification Policy.
  - **policyCode** (string) - Optional - The code of a standard Identity Verification Policy.
    * **Values for policyCode**:
      | Policy Code                  | Pass-To-Sign | Region | Retries |
      | :--------------------------- | :----------: | :----: | :-----: |
      | trulioo3_document            |     false    |   Any  |    2    |
      | trulioo3_document_required   |     true     |   Any  |    2    |
      | trulioo3_document_ca_strict  |     false    |   CA   |    2    |
      | trulioo3_document_ca_strict_required |     true     |   CA   |    2    |
    * **Note**: Pass-To-Sign indicates whether the signer must successfully complete identity verification before they can sign.
- **reminderOptions** (object) - Optional - Set package `Remind Me Later` options.
  - **reminderDays** (number) - Optional - Number of days from today to send a reminder notification.
  - **reminderMessage** (string) - Optional - Message to be sent with the reminder notification.

### Request Example
```json
{
  "allowModifyAnnotations": true,
  "verificationOptions": {
    "policyCode": "trulioo3_document_required"
  },
  "reminderOptions": {
    "reminderDays": 7,
    "reminderMessage": "Please sign this document."
  }
}
```

### Response
#### Success Response (200)
- **hasSecurityPassphrase** (boolean) - Indicates if the package is protected by a security passphrase.
- **locale** (string) - Language/locale for the package.
- **timeZone** (string) - Time zone for package date/time presentation.
- **format** (object) - Formatting options for dates and presentation.
  - **locale** (string, nullable) - Locale code used for formatting. Inherits from the package locale if not specified.
- **revisionsSigned** (number) - Number of signed revisions across package documents.
- **revisionsCount** (number) - Total number of revisions across package documents.
- **restrictedType** (string, nullable) - Restriction type applied to the package.
- **api** (boolean) - Indicates if the package was created via the API.
- **type** (string) - Package type identifier.
  * **Values for type**:
    | Value                | Description                                                                                     |
    | :------------------- | :---------------------------------------------------------------------------------------------- |
    | concurrent           | **Concurrent**: Allows multiple signers to sign the document simultaneously.                    |
    | Sequential           | **Sequential**: Requires signers to sign the document in a specific order.                      |
    | Counterpart          | **Group Send**: Enables group signing, where all signers receive the document at the same time. |
    | video_closing_room | **Video Signing Room**: A virtual room for signing documents via video conference.              |

#### Response Example
```json
{
  "hasSecurityPassphrase": false,
  "locale": "en-US",
  "timeZone": "America/New_York",
  "format": {
    "locale": "en-US"
  },
  "revisionsSigned": 0,
  "revisionsCount": 1,
  "restrictedType": null,
  "api": true,
  "type": "Sequential"
}
```
```

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

### Retrieve Package Information (HTTP)

Source: https://docs.iinkedsign.com/v4/api/packages/get

This snippet shows how to make an HTTP GET request to the /packages/{packageId} endpoint to retrieve detailed information about a specific package. The packageId is a required path parameter.

```http
GET /packages/{packageId}
```

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

### Create Package from Template using IDs

Source: https://docs.iinkedsign.com/v4/guides/templates

Creates a new package using a specified template, defining signers and recipients by their template IDs. This approach provides more precise control when specific IDs are available. It also includes template-associated documents by default.

```http
POST /packages/add
{
    "name": "From Template",
    "type": "concurrent",
    "templateId": "{{template_id}}",
    "state": "open",
    "signers": [
        {
            "templateSignerId": "{{template_signer_1_id}}",
            "firstName": "Signer",
            "lastName": "One",
            "email": "{{signer_1_email}}",
            "mobileNumber": null
        }
    ],
    "recipients": [
        {
            "templateRecipientId": "{{template_recipient_1_id}}",
            "firstName": "Recipient",
            "lastName": "One",
            "email": "{{recipient_1_email}}",
            "mobileNumber": null
        }
    ],
    "documents": []
}
```

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

### HTTP POST Request to Add Package with Redirect Options

Source: https://docs.iinkedsign.com/v4/guides/embed-editor

This HTTP request demonstrates how to add a package with embedded editing enabled and specifies a return URL for redirection after editing. It includes package details, embed options with returnUrl and returnState, signer information, and document details.

```http
POST /packages/add
{
  "name": "Embed Package Edtitor",
  "type": "concurrent",
  "state": "draft",
  "generateEditLink": true,
  "options": {
    "embed": {
      "focusTemplating": true,
      "returnUrl": "https://example.com/your-return-url",
      "returnState": "your-state"
    }
  },
  "signers": [
    {
      "firstName": "signer",
      "lastName": "one",
      "email": "signer.one@example.com"
    }
  ],
  "documents": [
    {
      "fileName": "document.pdf",
      "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
    }
  ]
}
```

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

### GET /templates/list

Source: https://docs.iinkedsign.com/v4/guides/templates

Retrieves a list of an organization's current templates. Supports filtering and pagination.

```APIDOC
## GET /templates/list

### Description
Retrieves a list of an organization members current templates.

### Method
GET

### Endpoint
/templates/list

### Query Parameters
- **memberId** (string) - Required - The ID of the member whose templates to retrieve.
- **sortBy** (string) - Optional - Specifies the sorting order for the templates (e.g., 'last_used').
- **take** (integer) - Optional - The maximum number of templates to return.
- **skip** (integer) - Optional - The number of templates to skip from the beginning of the list.

### Request Example
```json
{
    "memberId": "e4f0bce5-30fc-43c4-b9ee-364ff5b04dea",
    "sortBy": "last_used",
    "take": 100,
    "skip": 0
}
```

### Response
#### Success Response (200)
- **templates** (array) - A list of template objects.
  - **templateId** (string) - The ID of the template.
  - **signerRoles** (array) - The roles defined in the template.
  - ... (other template details)

#### Response Example
```json
{
  "templates": [
    {
      "templateId": "some-template-id",
      "signerRoles": ["Signer 1", "Recipient 1"],
      "name": "Example Template"
    }
  ]
}
```
```

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

### Package Creation and Update

Source: https://docs.iinkedsign.com/v4/reference/packages/package

This section details the parameters available when creating or updating a package, including security settings, identity verification, and reminder options.

```APIDOC
## POST /websites/iinkedsign

### Description
Creates a new package or updates an existing one with specified options.

### Method
POST

### Endpoint
/websites/iinkedsign

### Parameters
#### Request Body
- **allowModifyAnnotations** (boolean) - Optional - Allow PDF annotations.
- **allowModifyContents** (boolean) - Optional - Allow PDF editing.
- **allowPrinting** (boolean) - Optional - Allow PDF printing.
- **allowScreenReaders** (boolean) - Optional - Allow screen readers.
- **verificationOptions** (object) - Optional - Set identity verification options.
  - **policyId** (string) - Optional - The policy ID of the custom Identity Verification Policy.
  - **policyCode** (string) - Optional - The code of one of our standard Identity Verification Policy.
    * **Values for policyCode**:
      | Policy Code                  | Pass-To-Sign | Region | Retries |
      | :--------------------------- | :----------: | :----: | :-----: |
      | trulioo3_document            |     false    |   Any  |    2    |
      | trulioo3_document_required   |     true     |   Any  |    2    |
      | trulioo3_document_ca_strict  |     false    |   CA   |    2    |
      | trulioo3_document_ca_strict_required |     true     |   CA   |    2    |
- **reminderOptions** (object) - Optional - Set package `Remind Me Later` options.
  - **reminderDays** (number) - Optional - Number of days to send a reminder notification.
  - **reminderMessage** (string) - Optional - Message that will be sent with the reminder notification.
- **hasSecurityPassphrase** (boolean) - Optional - Set to `true` if the package is protected by a security passphrase.
- **locale** (string) - Optional - Language/locale for the package.
- **timeZone** (string) - Optional - Time zone for package date/time presentation.
- **format** (object) - Optional - Formatting options for dates and presentation.
  - **locale** (string) - Optional - Locale code used for formatting. Inherits from the package locale if not specified.

### Request Example
```json
{
  "allowModifyAnnotations": true,
  "verificationOptions": {
    "policyCode": "trulioo3_document_required"
  },
  "reminderOptions": {
    "reminderDays": 5,
    "reminderMessage": "Please sign this document."
  },
  "locale": "en-US",
  "format": {
    "locale": "en-US"
  }
}
```

### Response
#### Success Response (200)
- **revisionsSigned** (number) - Number of signed revisions across package documents.
- **revisionsCount** (number) - Total number of revisions across package documents.
- **restrictedType** (string) - Restriction type applied to the package. (nullable)
- **api** (boolean) - Set to `true` if the package was created via the API.
- **type** (string) - Package type identifier.
  * **Values for type**:
    | Value                | Description                                                                                     |
    | :------------------- | :---------------------------------------------------------------------------------------------- |
    | concurrent           | **Concurrent**: Allows multiple signers to sign the document simultaneously.                    |
    | Sequential           | **Sequential**: Requires signers to sign the document in a specific order.                      |
    | Counterpart          | **Group Send**: Enables group signing, where all signers receive the document at the same time. |
    | video_closing_room | **Video Signing Room**: A virtual room for signing documents via video conference.              |

#### Response Example
```json
{
  "revisionsSigned": 1,
  "revisionsCount": 2,
  "restrictedType": null,
  "api": true,
  "type": "Sequential"
}
```
```

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

### GET /packages/{packageId}/data

Source: https://docs.iinkedsign.com/v4/api/packages/data

Retrieves all field data for a specified package after it has been signed and finalized.

```APIDOC
## GET /packages/{packageId}/data

### Description
Fetches the values of all fields within a finalized iinkedsign package.

### Method
GET

### Endpoint
/packages/{packageId}/data

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The unique identifier of the package you want to retrieve field data for.

### Request Example
```http
GET /packages/your_package_id/data
```

### Response
#### Success Response (200)
- **field_name** (string) - The name of the field.
- **field_value** (string) - The value of the field.

#### Response Example
```json
{
  "field1_name": "field1_value",
  "field2_name": "field2_value"
}
```
```

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

### Get Package History

Source: https://docs.iinkedsign.com/v4/api/masterfile/export

Retrieves the history of a package, with options to filter by event types.

```APIDOC
## GET /websites/iinkedsign/packages/{packageId}/history

### Description
Retrieves the history of a specific package. You can optionally exclude certain event types from the history.

### Method
GET

### Endpoint
/websites/iinkedsign/packages/{packageId}/history

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The unique identifier of the package.

#### Query Parameters
- **excludeTypes** (string[]) - Optional - An array of event types to exclude from the results. Available types include:
  - document_added
  - document_deleted
  - document_regen
  - document_regen_signed
  - document_updated
  - document_updated_template
  - document_updated_template_annotation_added
  - document_updated_template_annotation_deleted
  - document_updated_template_annotation_updated
  - master_file_exported
  - meeting_added
  - meeting_deleted
  - meeting_updated
  - meeting_video_deleted
  - package_added
  - package_deleted
  - package_passphrase
  - package_sent
  - package_updated
  - recipient_added
  - recipient_deleted
  - recipient_updated
  - signer_added
  - signer_deleted
  - signer_updated
  - verification_viewed

### Request Example
```
GET /websites/iinkedsign/packages/pkg_12345/history?excludeTypes=recipient_added,signer_deleted
```

### Response
#### Success Response (200)
- **history** (array) - An array of history events for the package.
  - **type** (string) - The type of event.
  - **timestamp** (string) - The time the event occurred.
  - **details** (object) - Additional details about the event.

#### Response Example
```json
{
  "history": [
    {
      "type": "package_sent",
      "timestamp": "2023-10-27T10:00:00Z",
      "details": {
        "recipient": "user@example.com"
      }
    },
    {
      "type": "signer_added",
      "timestamp": "2023-10-27T10:05:00Z",
      "details": {
        "signer": "John Doe"
      }
    }
  ]
}
```
```

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

### Create Package from Template using Roles

Source: https://docs.iinkedsign.com/v4/guides/templates

Creates a new package using a specified template and defines signers and recipients by their template roles. This method is useful when role names are consistent and known. Documents associated with the template are automatically included.

```http
POST /packages/add
{
    "name": "From Template",
    "type": "concurrent",
    "templateId": "{{template_id}}",
    "state": "open",
    "signers": [
        {
            "templateRole": "Signer 1",
            "firstName": "Signer",
            "lastName": "One",
            "email": "{{signer_1_email}}",
            "mobileNumber": null
        }
    ],
    "recipients": [
        {
            "templateRole": "Recipient 1",
            "firstName": "Recipient",
            "lastName": "One",
            "email": "{{recipient_1_email}}",
            "mobileNumber": null
        }
    ],
    "documents": []
}
```

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

### GET /packages/{packageId}/status

Source: https://docs.iinkedsign.com/v4/guides/sign

Retrieves the current status of a signing package using its packageId. Useful for tracking progress.

```APIDOC
## GET /packages/{packageId}/status

### Description
Retrieves the current status of a signing package using its packageId. Useful for tracking progress.

### Method
GET

### Endpoint
/packages/{packageId}/status

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The ID of the package to check the status for.

#### Query Parameters
None

#### Request Body
None

### Request Example
```http
GET  /packages/{packageId}/status
```

### Response
#### Success Response (200)
- **packageId** (string) - The ID of the package.
- **name** (string) - The name of the package.
- **type** (string) - The type of the package.
- **state** (string) - The current state of the package (e.g., 'executed', 'open').
- **documents** (array) - A list of documents within the package, including their IDs and revisions.
- **signers** (array) - A list of signers associated with the package, including their IDs and names.

#### Response Example
```json
{
    "packageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "New Package",
    "type": "concurrent",
    "state": "executed",
    "documents": [
        {
            "documentId": "f3223ba8-ed0e-44eb-bee3-e99b03ff1b1f",
            "revisions": [
                {
                "revisionId": "4ee3d092-a390-4459-b5e1-753575d66af9",
                "signerId": "30d4193b-81d6-463e-a861-4e272c324991"
                }
            ]
        }
    ],
    "signers": [
        {
        "signerId": "30d4193b-81d6-463e-a861-4e272c324991",
        "firstName": "signer",
        "lastName": "one",
        "email": "signer.one@syngrafii.com"
        }
    ]
}
```
```
Tokens:
Raw