ZapSign API
Español
Español
  • Información General
  • Antes de empezar
  • Entornos de ZapSign
  • Solicitudes listas para usar
  • Autenticación
    • Token estático
    • Autenticación JWT
      • Obtener el access token
      • Actualizar access token
  • Tipos de Tokens
  • Versiones de la API
  • Políticas de Rate Limit
  • Alertas de Incidentes
  • Cómo Funciona el Pago
  • Códigos de estado
  • Cuenta
    • Información del Plan
    • Listar usuarios de la cuenta
    • Crear usuarios en la cuenta
    • Eliminar usuario de la cuenta
  • Documentos
    • Crear documento via Upload
    • OneClick - Clickwrap
      • Crear documento (OneClick)
    • Crear documento via Plantilla
    • Adicionar documento (sobre)
    • Adicionar documento extra via Plantilla
    • Detalle del documento
    • Listar documentos
    • Eliminar documento
    • Histórico de eventos
    • Posicionar firma (opcional)
    • Rechazar documentos
  • Firmantes
    • Detalles del firmante
    • Actualizar firmante
    • Adicionar firmante
    • Eliminar firmante
    • Firma en lote via API
    • Rechazar documentos por el usuario
  • Plantillas
    • Crear plantilla DOCX
      • Configurar formulario de plantilla
    • Listar plantillas
    • Actualizar plantilla
    • Eliminar plantilla
  • Aliados / Re-sellers
    • Actualizar estado de pago
    • Crear cuenta
  • Antecedentes
    • Introducción
    • Entendiendo el resultado
  • Crear un consulta (check)
    • Consulta de persona
    • Consulta de empresa
  • Consultar check
  • Detalle del check
  • Webhooks
    • ¿Cómo funcionan los webhooks?
    • Probar webhooks en ZapSign
    • Crear Webhook
    • Registro de Webhooks
    • Eventos
      • De documento
        • Doc creado
        • Doc eliminado
        • Firmante creado
      • De firmantes
        • Solicitud de firma enviada
        • Doc visualizado
        • Confirmación lectura
        • Doc firmado
        • Doc rechazado
        • Email bounce
        • Validación Fallida
      • De antecedentes
        • Consulta completada
    • Reprocesando documentos y webhooks
    • Eliminar Webhook
  • Widget
    • iFrame: ¿cómo funciona?
Powered by GitBook
On this page

Was this helpful?

  1. Documentos

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

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

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

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.

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.

PreviousEliminar documentoNextPosicionar firma (opcional)

Last updated 4 months ago

Was this helpful?