Get document history

This endpoint allows API users to retrieve the full history of a document.

For the events:

  • signer_authentication_success
  • signer_authentication_failure

the response may contain an additional parameter phone_number_2fa which shows the signer's phone number used for authentication method phone or sms.

For the event:

  • signer_authentication_success

the response may contain an additional parameter authentication_code which shows the code used for authentication method sms. The signer receives a code by SMS and enters this code to access the opened document.

get/document/{document_id}/historyfull

Request

Path parameters

ID of the document.

Response

Returns the history of the document.

For the events signer_authentication_success and signer_authentication_failure, json_attributes may contain phone_number_2fa.

emailstring

Email address of the user who performed the action.

eventstring

Name of the event, for example created_document or signed_document.

originstring

Origin of the event, for example original.

createdinteger

Unix timestamp of the event.

user_idstring

ID of the user who performed the action. null for actions not performed by a user.

field_idstring

ID of the field the action relates to. null if the action is not related to a field.

unique_idstring

ID of the history event.

element_idstring

ID of the element the action relates to. null if the action is not related to an element.

ip_addressstring

IP address the action was performed from.

document_idstring

ID of the document.

client_app_namestring

Name of the application the action was performed in.

json_attributesunknown
client_timestampinteger

Unix timestamp of the action on the client side. null if not available.

Changes

No recorded changes to this operation across all 1 revision of this API.