Delete signed document

Latest update: January 30th 2020

The following use case is assumed:

  • Owner of the request: API
  • Document status: only applies to signed documents. Remember that you can check the status of a request and the status of the documents with the service GET status.
Description
SERVICE REMOVE SIGNED DOCUMENT
URL /api/v3/documents/remove/{messageCode}
SECURITY YES
METHOD DELETE
CONTENT/APPLICATION URL PARAM
PARAMS messageCode: code of the signing process linked to the signed document to be deleted. The API that consumes it must be the owner of the process.
RESPONSE 200: HTTP status code 200/OK
RESPONSE BODY string with the operation's messageCode

Error Codes

Alternative responses in case of error: HTTP status codes other than 200/OK will be returned. In that case a JSON describing the problem will always be returned:

   {
      "code": "string",
      "type": "string",
      "message": "string"
    }

Example:

   {
      "code": 91,
      "type": "Error",
      "message": "Sorry, this application is not allowed."
    }

The API has used credentials that do not belong to the signing process linked to the document to be deleted.

    {
      "code": 236,
      "type": "Error",
      "message": "No es posible recuperar la información del mensaje solicitado",
      "trace": "com.viafirma.documents.api.model.exception.ApiException: no es posible recuperar la información del mensaje solicitado"
    }

The reported messageCode does not exist or has an incorrect parameter.

results matching ""

    No results matching ""