Audit Trail Download linked to a signing process

Latest update: May 13th, 2020

The following use case is assumed:

  • Owner of the request: API
  • Document status: any status. If it is not yet signed the audit-trail will show the status of the tasks or evidence when the download service is requested.
Description
SERVICE DOWNLOAD TRAIL
URL /api/v3/documents/download/trail/{messageCode}
SECURITY
METHOD GET
CONTENT/APPLICATION URL PARAM
PARAMS messageCode: code of the signing process linked to the signed document from which the audit-trail is to be obtained. The API that consumes it must be the owner of the process.
RESPONSE 200: HTTP status code 200/OK
RESPONSE BODY application/json

Response

{
 "link": "string",
 "fileName": "string",
 "expires": "timestamp milliseconds"
}
* "link": "URL direct download of the Audit Trail in PDF format.",
* "fileName": "PDF name",
* "expires": "date in milliseconds showing the expiration of the download LINK. 10 minutes by default."

Error codes

Alternative responses in case of error: HTTP status codes other than 200/OK will be returned. In this 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 used credentials that are not owned by 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 ""