Get document group history
This endpoint allows API users to retrieve the full history of a document group.
For the events:
- document_group_authentication_success
- document_group_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:
- document_group_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.
<details><summary>View the complete list of document group events:</summary>
| Event name | Meaning |
|---|---|
| document_group_created | The document group was created. |
| document_group_user_logged_in | A user logged in during interaction with the document group. |
| document_group_viewed | The document group was viewed. |
| document_group_approved | The document group was approved. |
| document_group_signed | The document group was signed. |
| document_group_sign_owner_attachment_sent | The completed document group was sent to the owner as an attachment. |
| document_group_sign_signer_attachment_sent | The completed document group was sent to the signer as an attachment. |
| document_group_downloaded | The document group was downloaded. |
| document_group_invite_sent | The document group invite was sent. |
| document_group_invite_resend | The document group invite was resent. |
| document_group_invite_completed | The document group invite was completed. |
| document_group_invite_cancelled | The document group invite was cancelled. |
| document_group_invite_full_declined | The document group invite was declined by all recipients. |
| document_group_invite_approver_full_declined | The document group invite was declined by all approvers. |
| document_group_fieldinvite_declined | The document group field invite was declined. |
| document_group_freeform_invite_sent | A FreeForm invite for the document group was sent. |
| document_group_freeform_invite_resend | A FreeForm invite for the document group was resent. |
| document_group_freeform_invite_cancelled | A FreeForm invite for the document group was cancelled. |
| document_group_freeform_invite_signed_by_user | A recipient signed a FreeForm invite for the document group. |
| document_group_freeform_invite_completed | A FreeForm invite for the document group was completed. |
| document_group_freeform_sign_owner_attachment_sent | The document group signed in a FreeForm invite was sent to the owner. |
| document_group_freeform_sign_signer_attachment_sent | The document group signed in a FreeForm invite was sent to the signer. |
| document_group_authentication_success | A document group signer successfully passed authentication. |
| document_group_authentication_failure | A document group signer failed to pass authentication. |
| document_group_approver_authentication_success | A document group approver successfully passed authentication. |
| document_group_approver_authentication_failure | A document group approver failed to pass authentication. |
| document_group_correction_start | A correction process started for the document group. |
| document_group_correction_finish | A correction process finished for the document group. |
Request
- Base URLhttps://api.signnow.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of the document group.
Headers
application/json
Response
Successful response. Returns the history events of the document group, with pagination details and a summary in meta. For the document_group_authentication_success and document_group_authentication_failure events, json_attributes contains authentication_type and phone_number_2fa.
The id_address attribute is deprecated. Use ip_address instead.
Changes
No recorded changes to this operation across all 1 revision of this API.