Error Handling

There are standard error responses for most of the endpoints.

400 - Bad Request

The format or structure for the request has not been accepted. Check to make sure your request is following the proper format. The response body will contain an error message.

{
	"error": {
        "code": "invalid_request_id_format",
        "message": "The request id provided is not in desired format."
	}
}

403 - Forbidden

You have not been authorized to request this endpoint. Check to make sure your token is valid and you are authorized to perform the request. The response body will contain an error message.

{
	"error": {
        "code": "unauthorized",
        "message": "The token is missing, invalid or not authorized to perform the request."
	}
}

404 Not Found

You are trying to find an ID and that ID does not exist. Check that your request ID is correct. The response body will contain an error message.

{
	"error": {
        "code": "invalid_request_id",
        "message": "The Request ID provided was not found."
    }
}

409 Conflict

The request does not exist, not finished, or has been cleaned up. Check to make sure that the request has completed and finished. The response body will contain an error message.

{
	"error": {
        "code": "extract_result_not_available",
        "message": "The extract result is not ready."
	}
}

500 Internal Server Error

Something went wrong unrelated to your request. Check the system status and try your request again. The response body will contain an error message.

{
	"error": {
        "code": "unknown_error",
        "message": "An unknown error occurred while processing the request."
	}
}


Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact us at support@zuva.ai