API version:
Archived documents
Retrieve Archived Documents and data
Metadata
:author: :name: RightSignature :contact: support@rightsignature.com :last_modified: 04-21-2020
Supported Formats
json
GET /public/v1/archived_documents_by_original_guid/:original_guid
Return data for a specific Archived Document (legacy RS)
Supported Formats
jsonErrors
Code | Description |
---|---|
400 | invalid_scope |
400 | unauthorized_client |
422 | Bad input parameter. Error message should indicate which one and why. |
401 | Can't find archived document. |
401 | Can't find user. |
401 | No ACLs tying user to archived document. |
Examples
GET /public/{version}/archived_documents_by_original_guid/3X6C3WIRL4L4NU3D8C4KFG 200 { "archived_document": { "id": "e4bce54d-8b2a-48be-8f0c-fecb1262b433", "name": "teada", "original_guid": "3X6C3WIRL4L4NU3D8C4KFG", "document_state": "executed", "document_sent_at": "2020-04-22T00:55:02.000-07:00", "document_executed_at": "2020-04-22T00:55:14.000-07:00", "document_expires_at": "2020-05-22T17:00:00.000-07:00", "sender_email": "test@test.com", "signers": [ { "id": "DGH4XHJ762ZH436WTSSVB7", "email": "test@test.com", "name": "Ad", "role_name": "A", "status": "signed", "message": "", "sequence": 1, "viewed_at": "2020-04-22T00:55:03-07:00", "signed_at": "2020-04-22T00:55:14-07:00", "document_passcode": null, "document_passcode_question": null, "dismiss_reminders": false, "legacy_browser_rendered": "", "email_bounced?": false, "has_previously_signed": false, "is_current_user": null, "reminders_remaining": 0 } ], "signed_pdf_url": "https://s3.amazonaws.com/dev.rightsignature.com/assets/5/sample-signed.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=OKe5hTNNEu%2FPqq38tPYSlLnY9ZM%3D", "page_images": [ { "page_number": 1, "thumbnail": "https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_p1_t.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=SYCkPvStWWX%2BUfzoYR5fJxcqoaw%3D", "original": "https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_s_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=ghXHzDDPklzy%2FvmGxLXcN215KjA%3D" }, { "page_number": 2, "thumbnail": "https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_p2_t.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=Ev69OFmJAqMjEuP7B3xo4iyuQKs%3D", "original": "https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_s_p2.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=AS7wrFbBNTnb%2FkMSSPGQI2Xo%2Bhk%3D" } ], "tags": { "legacy": "" }, "image_width": 675, "image_height": 874, "file_attachments": [], "cc_parties": [], "audits": [ { "id": 34, "payload": "All parties have signed document. Signed copies sent to: Ad.", "user_id": 2, "metadata": { "keyword": "executed" }, "account_id": 2, "created_at": "2020-04-22T00:55:14.000-07:00", "ip_address": null, "document_id": 5 }, { "id": 31, "payload": "Document created by Ad (test@test.com).", "user_id": 2, "metadata": { "keyword": "created" }, "account_id": 2, "created_at": "2020-04-22T00:55:02.000-07:00", "ip_address": "10.0.2.2", "document_id": 5 }, { "id": 33, "payload": "Document signed by Ad (test@test.com) with drawn signature.", "user_id": 2, "metadata": { "keyword": "signed" }, "account_id": 2, "created_at": "2020-04-22T00:55:14.000-07:00", "ip_address": "10.0.2.2", "document_id": 5 }, { "id": 32, "payload": "Document viewed by Ad (test@test.com).", "user_id": 2, "metadata": { "keyword": "viewed" }, "account_id": 2, "created_at": "2020-04-22T00:55:03.000-07:00", "ip_address": "10.0.2.2", "document_id": 5 } ], "shared_with": [], "user_id": "5f83d219-bbba-4bc3-a933-170543a7524e" } }
Params
Param name | Description |
---|---|
original_guid required |
Archived Document Original GUID Validations:
|