Histórico de eventos

El objetivo principal de este endpoint es permitir la recuperación del historial de actividad de un documento específico. Además, esta ruta te da la posibilidad de obtener el historial en formato JSON estándar o en formato de archivo PDF para descargarlo.

De esta manera, puedes acceder fácilmente al detalle de las acciones realizadas sobre el documento, ya sea para realizar un seguimiento o para tener un registro en PDF que puedas guardar.

GET https://api.zapsign.com.br/api/v1/docs/signer-log/{{doc_token}}?download_pdf=boolean

Encabezado

Nombre	Tipo	Descripción
Authorization*	string	API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Path Parameters

Nombre	Tipo	Descripción
doc_token	string	Token del documento que quieres consultar.

Query Parameters

Nombre	Tipo	Descripción
download_pdf	boolean	Este valor te permite decidir el tipo de respuesta que devolverá el endpoint. Si el valor es true, la respuesta será un archivo PDF con el historial de actividad del documento. En caso de que sea false o no se haya completado, la respuesta será una lista en formato JSON con los detalles de cada actividad asociada al token del documento enviado.

Sucessfull examples

Status 200 - JSON Format

[
    {
        "time": "2024-11-27 17:44:32.117577+00:00",
        "user": "[e-mail]",
        "event": "Documento firmado",
        "description": "Documento firmado por [e-mail]"
    },
    {
        "time": "2024-11-27 17:45:29.398835+00:00",
        "user": "[e-mail]",
        "event": "Validación de reconocimiento facial",
        "description": "Validación del rostro de [e-mail] con la foto del documento de identidad (anexo en el infome de firmas)"
    },
    {
        "time": "2024-11-27 17:45:40.904009+00:00",
        "user": "[e-mail]",
        "event": "Documento visualizado",
        "description": "Documento visualizado por [e-mail]"
    },
    {
        "time": "2024-11-21 05:18:45.733798+00:00",
        "user": "[e-mail]",
        "event": "Documento creado",
        "description": "El documento fue creado por [e-mail] via web"
    }
]

Status 200 - PDF file

In this way, the endpoint returns a direct download file, in the following model:

Errors examples

Status 401 - Unauthorized

For this error, the endpoint returns the value 401 in the StatusCode attribute, indicating that the token sent does not have permission to view the information in this document.

In this case, we suggest that you check whether the token sent in the Headers is correct according to the example already described above.

Status 404 - Not Found

In this error, the endpoint returns the StatusCode with a value of 404, indicating that the doc token sent was not found.

When this error occurs, we suggest checking whether the token sent in the endpoint url was the correct token.