Skip to main content

Sign API - Possible error codes

Mandatory parameters missing

Error code

R8001

Error description

This error occurs when the 'recipient email address' or 'signed_document_name' parameters not provided.

Error Response

{
    "error":  {
        "message": “One or more mandatory parameters are missing. Please try again with all required parameters.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8001”
    }
}

Unable to create a new sign request

Error code

R8002

Error description

This error occurs due to a temporary server issue or an invalid configuration during request creation.

Error Response

{
    "error":  {
        "message": “Unable to create a new Sign request. Retry the operation after checking your request parameters.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8002”
    }
}

Invalid account

Error code

R8003

Error description

This error occurs when the user invoking the API has not yet created an account in the selected Sign service.

Error Response

{
    "error":  {
        "message": “Please create an account in the chosen Sign service and try again.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8003”
    }
}

Zoho Sign credits exhausted

Error code

R8004, R8103

Error description

The maximum limit for sending documents for sign has reached. Upgrade license to send more documents for sign.

Error Response

{
    "error":  {
        "message": “Maximum limit for sending documents reached. Upgrade license to send more documents.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8004 / R8103”
    }
}

Unable to generate OAuth Tokens

Error code

R8005

Error description

This happens if the configured OAuth scopes are invalid or insufficient, or if the Sign configuration dialog is not accessed from UI once before sending the API request.

{
    "error":  {
        "message": “"An error occurred while generating OAuth tokens. Please check the added scopes or try accessing the Sign Workflow from the UI before using the API.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8005”
    }
}

Signer name not found

Error code

R8006

Error description

This error occurs when the in person signer name is not passed.

{
    "error":  {
        "message": "In-person signer name is missing. Please provide a valid name and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8006”
    }
}

Signer email address not found

Error code

R8007

Error description

This error occurs when the in person signer email address is not passed.

{
    "error":  {
        "message": "In-person signer email address is missing. Please provide a valid email address or different verification type and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8007”
    }
}

Verification code not found

Error code

R8008

Error description

This appears when the verification code was not provided while choosing the offline verification type.

{
    "error":  {
        "message": "Verification code is missing. Please provide a valid code for offline signer verification or choose a different verification type and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8008”
    }
}

Verification code limit exceeded

Error code

R8009

Error description

This error occurs when the provided verification code is shorter or longer than the required 6 characters.

{
    "error":  {
        "message": "Verification code must be exactly 6 characters long.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8009”
    }
}

Recipient country code not found

Error code

R8010

Error description

This error occurs when the country code required for phone-based verification or delivery is not included in the request.

{
    "error":  {
        "message": "Recipient country code is missing. Please provide a valid country code and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8010”
    }
}

Recipient phone number not found

Error code

R8011

Error description

This error occurs when the recipient's phone number is not provided in the request.

{
    "error":  {
        "message": "Recipient phone number is missing. Please provide a valid phone number and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8011”
    }
}

Invalid recipient email address

Error code

R8012

Error description

This error occurs when the email provided for hosting an in-person signing session does not belong to an active user in your Zoho Sign organization.

{
    "error":  {
        "message": "The recipient email is not associated with an active user in your Zoho Sign organization. Please use a valid email of an organization member to initiate the in-person signing session.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8012”
    }
}

Invalid plan

Error code

R8013

Error description

This error occurs when an in-person signing session is attempted under a Zoho Sign plan that does not support it.

{
    "error":  {
        "message": "In-person signing is available only with the Zoho Sign Enterprise plan. Please upgrade your plan and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8013”
    }
}

Insufficient permission

Error code

R8014

Error description

This error occurs when the recipient does not have 'Approver' role.

{
    "error":  {
        "message": "The Approver role is not supported in your current Zoho Sign plan. Please upgrade your plan and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8014”
    }
}

Recipients email addresses are empty

Error code

R8015

Error description

This error occurs when the recipients email addresses are not passed in the API request.

{
    "error":  {
        "message": "One or more recipient email addresses are missing. Please provide valid email addresses for all recipients and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8015”
    }
}

Credit points limit has exceeded

Error code

R8016

Error description

The maximum limit for performing the merge operations for your organization has reached for the month. Upgrade license to merge more documents.

{
    "error":  {
        "message": "Credit points limit reached for your organization. Please purchase more credit points to continue.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8016”
    }
}

Daily limit has reached

Error code

R8017

Error description

The maximum limit for merging the documents has reached for the day. To increase the daily limit, please fill in this form.

{
    "error":  {
        "message": "Daily API limits reached for your organization. Please extend your limits to continue.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8017”
    }
}

OAuth information not found

Error code

R8019

Error description

This error occurs when the OAuth details are not found.

{
    "error":  {
        "message": "OAuth information is missing. Please open the sign configuration dialog once and try using the API again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8019”
    }
}

Phone number differs

Error code

R8020

Error description

This error occurs when the phone number used for recipient verification does not match the phone number provided for document delivery.

{
    "error":  {
        "message": "Mismatched phone numbers found for recipient's verification and delivery. Please use the same phone number for both.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8020”
    }
}

Country code differs

Error code

R8021

Error description

This error occurs when the country code provided for recipient verification differs from the one used for delivery.

{
    "error":  {
        "message": "Mismatched country codes found in recipient's verification and delivery details. Please use the same country code for both.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8021”
    }
}

Zoho Sign account does not exist

Error code

R8022

Error description

This error occurs when the user attempting to perform an action has not created a Zoho Sign account.

{
    "error":  {
        "message": "Zoho Sign account not found. Please create an account and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8022”
    }
}

Unable to upload the document

Error code

R8101

Error description

The above error occurs when you are unable to upload the document to Sign.

{
    "error":  {
        "message": "Unable to upload the document.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8101”
    }
}

No signer fields for the recipients

Error code

R8102

Error description

All the recipients must have atleast one signer field. When no signer fields are available in the document for any of the recipients this error occurs.

{
    "error":  {
        "message": "Add atleast one field for a signer.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8102”
    }
}

Invalid Zoho Sign org id

Error code

R8104

Error description

This error occurs when the organization ID provided in the API request is invalid or not found.

{
    "error":  {
        "message": "The configured Zoho Sign organization ID does not exist. Please provide a valid org ID and try again.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R8104”
    }
}