> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Errors

## HTTP status codes

| Code | Title             | Description                                                                                                     |
| ---: | ----------------- | --------------------------------------------------------------------------------------------------------------- |
|  200 | OK                | The request has successfully been processed.                                                                    |
|  400 | Bad Request       | The request could not be processed because of an invalid request.                                               |
|  403 | Forbidden         | The user or API Key does not have permission to access the requested resource.                                  |
|  404 | Not Found         | The requested resource was not found.                                                                           |
|  429 | Too Many Requests | Too many requests over a short period of time have been made to the server from the same IP address or API Key. |
|  500 | Server Error      | An unexpected server error has occurred.                                                                        |

### Examples

<Tabs>
  <Tab title="400">
    ```json theme={null}
    {
      "error": "package_invalid_type",
      "message": "Valid Package 'type' is required."
    }
    ```
  </Tab>

  <Tab title="404">
    ```json theme={null}
    {
      "error": "package_not_found",
      "message": "The Package was not found or you do not have permission to access the Package."
    }
    ```
  </Tab>
</Tabs>

## Common error patterns

Common errors such as data length, range, or type will be returned with a dynamic error code that follows these patterns.

| Error pattern                    | Meaning                                                                                             |
| -------------------------------- | --------------------------------------------------------------------------------------------------- |
| `{type}_not_found`               | **Not Found**: The requested resource was not found.                                                |
| `{type}_not_authorized`          | **Not Authorized**: The current user or API Key is not authorized to access the requested resource. |
| `{type}_invalid_{error}`         | **Invalid**: The request is invalid.                                                                |
| `{type}_exception_{error}`       | **Exception**: An exception occurred while processing the request.                                  |
| `{type}_feature_{error}`         | **Feature**: The current organization's subscription does not have the required feature enabled.    |
| `{type}_not_safe_{propertyName}` | **Not Safe**: The property contains data considered unsafe to store or share with other users.      |
| `{type}_length_{propertyName}`   | **Invalid Length**: The property data length is too short or too long.                              |
| `{type}_range_{propertyName}`    | **Invalid Range**: The property data value is outside its allowed range.                            |

## Package errors

| Error                                                     | Description                                                                                                                |
| :-------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------- |
| package\_add\_no\_documents                               | At least one document is required to add package in `open` state.                                                          |
| package\_add\_no\_signers                                 | At least one signer is required to add package in `open` state.                                                            |
| package\_delete\_retention                                | Package is under a retention policy and cannot be deleted.                                                                 |
| package\_duplicate\_recipients                            | One or more recipients have the same email address.                                                                        |
| package\_duplicate\_recipients\_signer                    | One or more recipients have the same email address as a signer.                                                            |
| package\_duplicate\_signers                               | One or more signers have the same email address.                                                                           |
| package\_duplicate\_signers\_host                         | One or more signers have the same email address as the host.                                                               |
| package\_exception                                        | An unexpected error has occurred while processing the Package.  Please contact iinked Sign Support for further assistance. |
| package\_exception\_cancel\_not\_open                     | Package is no longer in a open state and cannot be cancelled.                                                              |
| package\_exception\_send\_no\_documents                   | Package requires at least one document before sending to signers.                                                          |
| package\_exception\_send\_not\_draft                      | Package is no longer in a draft state and cannot be sent.                                                                  |
| package\_exception\_send\_owner\_deleted                  | Package owner has been deleted and can no longer be sent.                                                                  |
| package\_exception\_sign\_not\_open                       | Package is no longer available for signing.                                                                                |
| package\_exception\_sign\_owner\_deleted                  | Package is no longer available for signing.                                                                                |
| package\_exception\_update\_not\_updatable                | You can no longer update this package.                                                                                     |
| package\_exception\_update\_package\_type\_not\_updatable | You can no longer update the package type.                                                                                 |
| package\_export\_forbidden                                |                                                                                                                            |
| package\_feature\_package\_type                           | You must upgrade your subscription to create a {0} Package.                                                                |
| package\_invalid\_date                                    |                                                                                                                            |
| package\_invalid\_recipient                               | Package owner cannot be added as a recipient.                                                                              |
| package\_invalid\_search                                  | Your search contains invalid characters.                                                                                   |
| package\_invalid\_security\_code\_signer\_mobile\_number  |                                                                                                                            |
| package\_invalid\_security\_passphrase                    | You must provide a valid security passphrase.                                                                              |
| package\_invalid\_time\_zone                              | You must provide a valid time zone.                                                                                        |
| package\_link\_not\_generated                             | Failed to generate the requested package link.                                                                             |
| package\_locked                                           | Package is currently being updated by another member.                                                                      |
| package\_modification\_limit\_exceeded                    | This package has exceeded the modification limit and can no longer be updated.                                             |
| package\_no\_host                                         | Package must have one Signer assigned 'host' role.                                                                         |
| package\_no\_signers                                      |                                                                                                                            |
| package\_not\_authorized                                  | The Package was not found or you are not authorized to access the Package.                                                 |
| package\_not\_authorized\_add                             | You are not authorized to add packages.                                                                                    |
| package\_not\_authorized\_state                           | You are not authorized to add packages in '{0}' state.                                                                     |
| package\_not\_found                                       | The Package was not found or you are not authorized to access the Package.                                                 |
| package\_not\_safe\_message                               | 'Message' cannot contain any website domains or email addresses while subscription is under a trial.                       |
| package\_notification\_exception\_link\_text              | You must provide 'linkText' when including a 'link' in the notification.                                                   |
| package\_notification\_link\_text                         |                                                                                                                            |
| package\_one\_host                                        | There can only be one host.                                                                                                |
| package\_options\_invalid\_enhancedPrivacy                | {0} '{1}' cannot be enabled for this package type.                                                                         |
| package\_options\_message\_not\_safe                      | The system message '{0}' cannot contain any website domains or email addresses.                                            |
| package\_options\_message\_not\_safe\_trial               | The system message '{0}' cannot contain any website domains or email addresses while subscription is under a trial.        |
| package\_rescind\_not\_open                               |                                                                                                                            |
| package\_review\_forbidden                                | You can no longer review documents for this package.                                                                       |
| package\_update\_delete\_host                             | Host cannot be deleted from a {0} package.                                                                                 |
| package\_update\_delete\_signer\_not\_found               | Signer {0} does not exist and cannot be deleted from package.                                                              |
| package\_update\_no\_signers                              | At least one signer is required after updating a package.                                                                  |
| package\_verification\_not\_supported                     | Identity verification is not supported for this package type.                                                              |

## Document errors

| Error                     | Description                                                                                                                |
| :------------------------ | :------------------------------------------------------------------------------------------------------------------------- |
| document\_exception       | An unexpected error has occurred while processing the Document. Please contact iinked Sign Support for further assistance. |
| document\_not\_authorized | The Document was not found or you are not authorized to access the Document.                                               |
| document\_not\_found      | The Document was not found or you are not authorized to access the Document.                                               |

## Signer errors

| Error                                   | Description                                                                                                                       |
| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| signer\_exception                       | An unexpected error has occurred while processing the Document Signer. Please contact iinked Sign Support for further assistance. |
| signer\_forward\_invalid\_email         | A Signer with the provided email address already exists in the Package.                                                           |
| signer\_invalid\_email\_exists          | A Document Signer already exists with the provided email address.                                                                 |
| signer\_invalid\_mobile\_number\_exists | A Document Signer already exists with the provided mobile number.                                                                 |
| signer\_invalid\_package\_started       | You cannot add a Signer to a Signing Package that has already been started.                                                       |
| signer\_invalid\_role                   | The Signer Role is invalid for the Package Type.                                                                                  |
| signer\_location\_required              | You are required to share your location before you can continue.                                                                  |
| signer\_lockout                         | You are temporarily locked out of this document. Try again later.                                                                 |
| signer\_not\_authorized                 | The Document Signer was not found or is longer authorized to access the Document.                                                 |
| signer\_not\_found                      | The Document Signer was not found or is no longer authorized to access the Document.                                              |
| signer\_security\_code\_challenge       | You must provide security code sent to your mobile device to access the Package.                                                  |
| signer\_security\_not\_authorized       |                                                                                                                                   |
| signer\_security\_passphrase\_challenge | You must provide secret passphrase to access the Package.                                                                         |

## Form errors

| Error                                    | Description                                                     |
| :--------------------------------------- | :-------------------------------------------------------------- |
| form\_exception\_create                  | We were not able to start your signing. Please try again later. |
| form\_exception\_create\_already\_signer | You are already a secondary signer or recipient on this form.   |
| form\_not\_authorized                    |                                                                 |
| form\_not\_available                     | The requested signing form is no longer active.                 |

## Template errors

| Error                                          | Description                                                                                                    |
| :--------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| template\_code\_exists                         | The template code is already associated with an existing template.                                             |
| template\_code\_reserved                       | This template code is exclusively designated for global templates. Please select an alternative template code. |
| template\_document\_code\_exists               | Each document must have a unique document code.                                                                |
| template\_forward\_signing\_not\_authorized    | You are not authorized to enable Forward Signing.                                                              |
| template\_not\_authorized                      | The Template was not found or you are not authorized to access the Template.                                   |
| template\_recipient\_duplicate\_template\_role | All recipient role names must be unique in a template.                                                         |
| template\_signer\_duplicate\_template\_role    | All signer role names must be unique in a template.                                                            |

## File errors

| Error                                  | Description                                                                                                       |
| :------------------------------------- | :---------------------------------------------------------------------------------------------------------------- |
| file\_conversion\_failed               | We were not able to convert the file '{0}' to PDF. Try exporting it as a PDF from the application directly.       |
| file\_conversion\_invalid\_page\_count | The file cannot be converted as it's {0} pages exceed the maximum number of {1} pages supported.                  |
| file\_conversion\_max\_size\_exceeded  | Converted PDF file size has exceeded the maximum file size of {0}.                                                |
| file\_conversion\_not\_supported       | Conversion to PDF is not supported for the uploaded file '{0}'.                                                   |
| file\_exception                        |                                                                                                                   |
| file\_exception\_form\_fields          | While saving your document we were unable to update one or more form fields. Please try again or contact support. |
| file\_exception\_merge\_tags           | An unexpected error occurred while processing the file for 'merge' tags.                                          |
| file\_exception\_metadata\_annotation  |                                                                                                                   |
| file\_exception\_pdf\_annotation       |                                                                                                                   |
| file\_exception\_template\_tags        | An unexpected error occurred while processing the file for 'template' tags.                                       |
| file\_invalid                          | Invalid file ({0}).                                                                                               |
| file\_invalid\_custom\_field\_anchor   |                                                                                                                   |
| file\_invalid\_custom\_field\_tag      |                                                                                                                   |
| file\_invalid\_data                    | Invalid file.                                                                                                     |
| file\_invalid\_empty                   | Invalid file. File is empty.                                                                                      |
| file\_invalid\_external\_file\_id      | Invalid external file 'fileExternalId'.                                                                           |
| file\_invalid\_external\_id\_exists    | A file already exists with an 'externalId' of '{0}'.                                                              |
| file\_invalid\_file\_id                | Invalid internal file 'fileId'.                                                                                   |
| file\_invalid\_not\_found              | The file '{0}' is invalid or no longer exists.                                                                    |
| file\_invalid\_url                     | Invalid external file 'url'.                                                                                      |
| file\_not\_authorized                  | You are not authorized to add files.                                                                              |
| file\_not\_supported                   | File contains features that are not supported and cannot be processed.                                            |
| file\_not\_supported\_acro\_form       | File contains an unsupported or invalid PDF Form and cannot be processed.                                         |
| file\_not\_supported\_io\_error        | PDF Error                                                                                                         |
| file\_not\_supported\_pdf\_error       | PDF Error                                                                                                         |
| file\_not\_supported\_xfa              | File contains an unsupported PDF Form (Dynamic XFA) and cannot be processed.                                      |
| file\_password\_protected              | File is password protected and cannot be processed.                                                               |
| file\_pdf\_scan\_exception             | PDF scanning error. Could not scan pdf properties and text content.                                               |
