Document Audit Trail
The main purpose of this endpoint is to enable the recovery of the activity history for a specific document. The route also provides the possibility of returning it in standard JSON format, or in PDF file format for download.
Get Audit Trail
GET
https://api.zapsign.com.br/api/v1/docs/signer-log/{{doc_token}}?download_pdf=boolean
GET
https://api.zapsign.com.br/api/v1/docs/signer-log/{{doc_token}}?download_pdf=boolean
Headers
Authorization*
string
apiToken written ahead of the "Bearer" text.
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Path Parameters
doc_token
string
Token of the document for which you want to get the activity history
Query Parameters
download_pdf
boolean
Value that allows you to decide the type of return that the endpoint will return.
Ex.:
download_pdf=true
or
download_pdf=false
If the value is true, the return will be a PDF file with the activity history. In case if it's false or not filled in, a list will be returned, in JSON format, with the values of each activity of the document token sent.
Sucessfull examples
[
{
"time": "2024-11-27 17:44:32.117577+00:00",
"user": "[email protected]",
"event": "Documento visualizado",
"description": "Documento visualizado por [email protected]"
},
{
"time": "2024-11-27 17:44:34.395952+00:00",
"user": "[email protected]",
"event": "Confirmação de leitura",
"description": "Confirmação de leitura de [email protected]"
},
{
"time": "2024-11-27 17:45:29.398835+00:00",
"user": "[email protected]",
"event": "Validação reconhecimento facial",
"description": "Validação do rosto de [email protected] com a foto do documento de identidade (anexo no relatório de assinaturas)"
},
{
"time": "2024-11-27 17:45:40.904009+00:00",
"user": "[email protected]",
"event": "Aceitação do processamento de dados pessoais",
"description": "[email protected] 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": "[email protected]",
"event": "Documento created",
"description": "O documento foi criado por [email protected] via web"
}
]
Errors examples
Last updated
Was this helpful?