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 resource was not found.
`405 Method Not Allowed`	The request cannot be executed with the given HTTP verb.
`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 List

On the next page you will find the list of all errors and their description Yousign API can send back on client error (4XX HTTP requests).