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

NombreTipoDescripción

Authorization*

string

API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Path Parameters

NombreTipoDescripción

doc_token

string

Token del documento que quieres consultar.

Query Parameters

NombreTipoDescripció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

[
    {
        "time": "2024-11-27 17:44:32.117577+00:00",
        "user": "jose.da.silva@teste.com.br",
        "event": "Documento visualizado",
        "description": "Documento visualizado por jose.da.silva@teste.com.br"
    },
    {
        "time": "2024-11-27 17:44:34.395952+00:00",
        "user": "jose.da.silva@teste.com.br",
        "event": "Confirmação de leitura",
        "description": "Confirmação de leitura de jose.da.silva@teste.com.br"
    },
    {
        "time": "2024-11-27 17:45:29.398835+00:00",
        "user": "jose.da.silva@teste.com.br",
        "event": "Validação reconhecimento facial",
        "description": "Validação do rosto de jose.da.silva@teste.com.br com a foto do documento de identidade (anexo no relatório de assinaturas)"
    },
    {
        "time": "2024-11-27 17:45:40.904009+00:00",
        "user": "jose.da.silva@teste.com.br",
        "event": "Aceitação do processamento de dados pessoais",
        "description": "jose.da.silva@teste.com.br concordou com o processamento de dados pessoais de acordo com a Política de Privacidade"
    },
    {
        "time": "2024-11-21 05:18:45.733798+00:00",
        "user": "jose.da.silva@teste.com.br",
        "event": "Documento criado",
        "description": "O documento foi criado por jose.da.silva@teste.com.br via web"
    }
]

Errors examples

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.

Last updated