API version:
PUT /public/v2/documents/:id/update_pin
Updates the document PIN
Supported Formats
jsonErrors
Code | Description |
---|---|
400 | invalid_scope |
400 | unauthorized_client |
401 | Can't find document. |
401 | Can't find user. |
401 | No ACLs tying user to document. |
422 | Hash contains empty keys |
Examples
POST /public/{version}/documents/37f8bf7f-b57a-4774-998a-cbf7a8cd8367/update_pin { "access_token": "bec095efd15e463077ae678b4a6ac4d3b07961be58d7f8e1216a573c3be71aaf", "pin": "12345", "document": {} } 200 { "document": { "id": "37f8bf7f-b57a-4774-998a-cbf7a8cd8367", "current_signer_id": "f55f6dfc-2acd-488f-a386-9e5b98ed5a11", "name": "Test", "filename": "application.pdf", "executed_at": null, "expired_at": "2018-06-06T08:23:30.517-07:00", "sent_at": "2018-05-07T08:23:30.493-07:00", "state": "pending", "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=ZzZMm4z8qO2nyp2CeIcwae6TJXY%3D", "sender": { "id": "bb1853a5-6e20-49d0-80fd-618b4743639b", "name": "Elizabeth Sauer", "email": "kaylee@daniel.biz", "signer": false }, "recipients": [ { "role_name": "signer2", "name": "Susie Orange", "email": "susie@citrix.com", "status": "pending", "id": "4ab3c881-3654-4e45-a889-a972a803bca8", "sign_url": "https://secure.rs.dev:3000/signers/4ab3c881-3654-4e45-a889-a972a803bca8/sign?access_token=n1zQmxzV3qbcoU4kmP-n", "remind_url": "https://api.rs.dev:3002/public/{version}/signers/4ab3c881-3654-4e45-a889-a972a803bca8/reminders", "message": "Please sign.", "sequence": 1 }, { "role_name": "signer1", "name": "Joe Tangerine", "email": "joe@citrix.com", "status": "pending", "id": "f55f6dfc-2acd-488f-a386-9e5b98ed5a11", "sign_url": "https://secure.rs.dev:3000/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/sign?access_token=nys8UFjgFrPoypgD5oYf", "remind_url": "https://api.rs.dev:3002/public/{version}/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/reminders", "message": "Please sign.", "sequence": 0 } ], "audits": [], "page_image_urls": [ "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D" ], "signed_pdf_url": null, "tags": {}, "merge_field_values": [], "embed_codes": null, "in_person": false, "shared_with": [ "test@test.com" ], "identity_method": "email", "passcode_pin_enabled": false, "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/eb29e5cf-e952-4904-91b3-9a554d68b963/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=0e49QufHCocBjl3AuN%2FUSwD%2B0Qw%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf" } }
Params
Param name | Description |
---|---|
pin required |
Document pin. Must be between 10000 and 99999 |