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
- 400
- 404
{
"error": "package_invalid_type",
"message": "Valid Package 'type' is required."
}
{
"error": "package_not_found",
"message": "The Package was not found or you do not have permission to access the Package."
}
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_duplicate_witnesses_signer | One or more witnesses have the same email address as a signer. |
| 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_ds | You must upgrade your subscription to use digital signatures in a package. |
| package_feature_ds_digidentity | You must upgrade your subscription to use Digidentity digital signatures in a package. |
| package_feature_package_type | You must upgrade your subscription to create a Package. |
| package_feature_witness | You must upgrade your subscription to include witnesses in a package. |
| package_invalid_date | The package’s sign-by date must be in the future. |
| package_invalid_meeting | The package’s meeting date must be in the future. |
| 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 | All signers require a mobile number to enable Text Message Multi-Factor Authentication. |
| 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 '' 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_digital_signature_require_cac_none | |
| package_options_digital_signature_require_flattening_none | |
| package_options_invalid_enhancedPrivacy | '' cannot be enabled for this package type. |
| package_options_message_not_safe | The system message '' cannot contain any website domains or email addresses. |
| package_options_message_not_safe_trial | The system message '' cannot contain any website domains or email addresses while subscription is under a trial. |
| package_options_notice_not_safe | A consent notice '' cannot contain any website domains or email addresses. |
| package_options_notice_not_safe_on_trial | A consent notice '' cannot contain any website domains or email addresses while subscription is under a trial. |
| package_options_notice_not_safe_trial | |
| package_options_require_consent | When CAC is set to none, Require Consent must be enabled and must require signing or video recording. |
| package_options_securityCode_not_allowed_on_trial | Multi-Factor Authentication is not available while your account is on trial. |
| package_rescind_not_open | |
| package_review_forbidden | You can no longer review documents for this package. |
| package_send_invalid_state | The package cannot be sent in its current state. |
| package_send_no_documents | The package must contain at least one document before it can be sent. |
| package_send_not_ready | Package cannot be sent, add at least one document or enable identity verification for a signer. |
| package_update_delete_host | Host cannot be deleted from a package. |
| package_update_delete_signer_not_found | Signer 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 verification 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. |
| signer_witness_not_allowed | Signer Witness is not allowed for this package type |
Form errors
| Error | Description |
|---|---|
| form_exactly_one_form_signer | A single signer must be designated with the ‘form’ type. |
| 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_invalid_package_type | The selected package type is not compatible with forms. |
| 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 '' 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 pages exceed the maximum number of pages supported. |
| file_conversion_max_size_exceeded | Converted PDF file size has exceeded the maximum file size of . |
| file_conversion_not_supported | Conversion to PDF is not supported for the uploaded file ''. |
| 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 (). |
| 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 ''. |
| file_invalid_file_id | Invalid internal file ‘fileId’. |
| file_invalid_not_found | The file '' 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. |