Error types

HTTP Status Code	Code
`400 Bad Request`	Invalid request.
`401 Unauthorized`	Invalid authentication, check that your are using the correct API Key on the right environment (Sandbox / Production).
`403 Forbidden`	Access to this resource is forbidden in this context.
`404 Not Found`	The requested ressource was not found.
`429 Too Many Requests`	Too many requests sent in a given amount of time. Please reduce the number of calls or rely on webhooks instead of polling. Learn more about rate-limiting.
`500 Internal Server Error`	Servers are not working as expected. The request is probably valid but needs to be requested again later.
`503 Service Unavailable`	We are currently under maintenance.

Understanding 4XX Errors

To help you troubleshoot your issues, all the 4XX errors contain additionnal information in the JSON response.

Attribute	Description
type required	Key that identify the error type
detail required	Human readable message explaining the error
invalid_params	Only present for errors of type `validation.error` or `parameters_not_valid`. Array of objects with attributes: - `name` identifying the concerned field and - `reason` describing the validation issue

{
    "type": "validation.error",
    "detail": "You have some invalid params in your payload.",
    "invalid_params": [
        {
            "name": "delivery_mode",
            "reason": "Value must be in [\"none\", \"email\"]."
        }
    ]
}

{
    "type": "document.unable_to_download_signature_request_not_in_done",
    "detail": "The signature request \"80c30a0e-84cd-4574-8161-8669f6603189\" is still ongoing, the completed documents are not available yet"
}

Errors we send back on any Client error (4xx HTTP requests).

Error code	Description
audit_trail.not_ready_for_download	The audit trail is not ready to be downloaded yet
approver.already_attached_to_signature_request	An approver with the same information is already attached to the Signature Request.
consumption.date_out_of_range	The given date range is out of the valid range.
contact.workspace_not_identical	A contact restricted to a single workspace cannot be used as a signer or approver for a signature request from another workspace.
date.out_of_range	The given date range is invalid: the start date is greater than the end date.
document.already_attached_to_a_signature_request	The document is already attached to a Signature Request. To attach a document to another Signature Request you need to re-upload it first.
document.already_attached_to_an_electronic_seal	The document is already used for another electronic seal.
document.not_replaceable	Unable to replace the document.
document.not_unlockable	Cannot upload the document because it fails to be unlocked.
document.not_usable	The document is not valid. For example its extension is invalid, or it's not readable.
document.size_too_large	Size of document is too large to be performed
electronic_seal_image.limit_reached	The limit of images for the electronic seal has been reached.
electronic_seal.too_many_fields	The limit of fields for the electronic seal has been reached.
field.dimensions_not_valid	The dimensions for the field are invalid.
field.only_one_of_type_signature_per_document_and_signer	With the current signature level, only one signature field per document and per signer is allowed.
field.type_not_allowed_for_document	The field type is not allowed for the document. It might be because the document is already signed or the document doesn't support this kind of field.
otp.not_valid	The given OTP (one-time password) is invalid.
otp.no_longer_usable	The given OTP (one-time password) cannot be used anymore.
otp.phone_number_not_compatible	The phone number is not compatible with the current OTP mechanism.
otp.too_many_requests	Too many OTP requests done in the allowed time frame. The cooldown period lasts 15 seconds.
parameters_not_valid	You have some invalid params in your payload.
resource.not_found	This error corresponds to the 404 HTTP error for any resource.
signature_request.expiration_date_out_of_range	The given Signature Request's expiration date is not within the allowed range.
signature_request.delivery_mode_not_compatible	The current action is not compatible with the current delivery mode.
signature_request.no_document	The Signature Request doesn't have any document, therefore the actual action cannot be performed.
signature_request.not_activatable	The Signature Request is not activable in its current state.
signature_request.not_reactivable	The Signature Request can't be reactivated.
signature_request.metadata_already_exists	The Signature Request already has metadata. You can still update them.
signature_request.migrated	The signature request is migrated from an older version, it cannot be permanently deleted.
signature_request.sender_not_valid	There is an error in the signature request's sender configuration.
signature_request.status_not_compatible	The actual action is not compatible with the Signature Request's status.
signature_request.too_many_documents	The number of documents in the Signature Request is greater than the authorized number.
signature_request.too_many_signers	The number of signers in the Signature Request is greater than the authorized number.
signer.already_attached_to_signature_request	A signer with the same information is already attached to the Signature Request.
signer.authentication_mode_not_allowed_for_signature_level	The authentication mode and the signature level for the signer are not compatible.
signer.authentication_mode_not_compatible	The Signer authentication mode is not compatible with the current action.
signer.authentication_mode_not_enabled_for_signature_level	The signature level with the given authentication mode is not enabled for your organization.
signer.field_required	The Signer does not have any field. You need at least one field per Signer.
signer.otp_required	The Signer is associated to an authentication mode requiring an OTP (one-time password).
signer.phone_number_required	Signer's phone number is required in this case.
signer.reordering_not_allowed	Reordering Signers is not allowed in this context.
signer.signature_level_not_available	The given signature level for Signer is not available in the current context.
signer.signature_level_not_compatible	The Signer signature level is not compatible with the current action
signer.signature_level_not_enabled	The signature level is not enabled for your organization.
signer.signature_level_not_identical_for_all	All Signers should have the same signature level for this specific Signature Request level.
signer.status_not_compatible	The current action is not compatible with the Signer's status.
subscription.limit_reached	A limit has been reached concerning your current subscription.
subscription.status_not_compatible	The subscription status is not compatible with the current action