RightSignature API
\n","copyright":2026,"doc_url":"/documentation/resources/v2","api_url":"/public/v2/","resources":{"oauth_authorizations":{"doc_url":"/documentation/resources/v2/oauth_authorizations","id":"oauth_authorizations","api_url":"/public/v2/","name":"Oauth authorizations","short_description":"OAuth2.0 Authorization Grant","full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/documentation/resources/v2/oauth_authorizations/default_url_options","name":"default_url_options","apis":[{"api_url":"/oauth/authorize","http_method":"GET","short_description":"Return an OAuth 2.0 authorization code grant type","deprecated":null}],"formats":["json"],"full_description":"\nRequests an OAuth2.0 authorization code grant type.
\n\nThe user will first be prompted to login to RightSignature to validate their identity and will be prompted to authorize or deny access to their account. RightSignature will redirect the user-agent to the configured redirect_uri along with an authorization_code parameter after access has been authorized. This code can than be exchanged for an access token.
\n","errors":[{"code":403,"description":"Forbidden","metadata":["OAuth2 Error"]}],"params":[{"name":"client_id","full_name":"client_id","description":"\nThe API Key’s Client ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"redirect_uri","description":"\nWhere the user-agent will be redirected to after an authorization code is granted. Note that this MUST match what is on record with the API Key associated with the passed in client id
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"response_type","full_name":"response_type","description":"\nRequests the authorization code grant
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:code.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\nLevel of access that the application is requesting.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:read, write, read write.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["REQUEST:\nhttps://api.rightsignature.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code\n\nUSER-AGENT REDIRECT:\nhttps://your_redirect_uri?code=AUTHORIZATION_CODE\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"oauth_tokens":{"doc_url":"/documentation/resources/v2/oauth_tokens","id":"oauth_tokens","api_url":"/public/v2/","name":"Oauth tokens","short_description":"OAuth 2.0 Access Token","full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/documentation/resources/v2/oauth_tokens/create","name":"create","apis":[{"api_url":"/oauth/token","http_method":"POST","short_description":"Request an Access Token","deprecated":null}],"formats":["json"],"full_description":"\nRequesting an Access Token:
\n\nOnce an authorization code is obtained, it can be exchanged for an access token. Access tokens expire after two hours but can be re-issued by using the refresh token.
\n\nIf successfull the access token can be used in subsequent requests to the api. This can be accomplished by including in the header of the request or as a query parameter.
\n","errors":[{"code":403,"description":"Forbidden","metadata":["OAuth2 Error"]}],"params":[{"name":"client_id","full_name":"client_id","description":"\nThe API Key’s Client ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\nThe API Key’s Client Secret
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_uri","full_name":"redirect_uri","description":"\nThe API Key’s redirect uri that was used in the authorization grant request
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"code","description":"\nThe code that was included as a param in the redirect after authorizing
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Creating a new OAuth2 Token\n\n POST application/x-www-form-urlencoded:\n\n curl -F grant_type=authorization_code \\\n -F client_id=CLIENT_ID \\\n -F client_secret=CLIENT_SECRET \\\n -F code=AUTHORIZATION_CODE_FROM_REDIRECT \\\n -F redirect_uri=REDIRECT_URI \\\n -X POST https://api.rightsignature.com/oauth/token\n\n\n RESPONSE:\n\n {\n \"access_token\": ACCESS_TOKEN,\n \"token_type\": \"bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": REFRESH_TOKEN,\n \"scope\": \"read\",\n \"created_at\": 1788825624\n }\n\n================================================================================\n\nRefreshing an existing OAuth2 Token\n\n POST application/x-www-form-urlencoded:\n\n curl -F grant_type=refresh_token \\\n -F refresh_token=REFRESH_TOKEN \\\n -F client_id=CLIENT_ID \\\n -F client_secret=CLIENT_SECRET\n -X POST https://api.rightsignature.com/oauth/token\n\n\n RESPONSE:\n\n {\n \"access_token\": ACCESS_TOKEN,\n \"token_type\": \"bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": REFRESH_TOKEN,\n \"scope\": \"read\",\n \"created_at\": 1788825624\n }\n","HEADER:\n\ncurl --header \"Authorization: Bearer a503faf9-45b5-4fec-8334-337284a66ea4\" https://api.rightsignature.com/public/v1/documents/12345678\n\nQUERY PARAMETER:\n\ncurl https://api.rightsignature.com/public/v1/documents/12345678?access_token=a503faf9-45b5-4fec-8334-337284a66ea4\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/oauth_tokens/revoke","name":"revoke","apis":[{"api_url":"/oauth/revoke","http_method":"POST","short_description":"Revoke an existing Access Token","deprecated":null}],"formats":["json"],"full_description":"\nRevoking an Access Token
\n\nRevoking an access token will delete it from the server.
\n\nThere are 2 ways to authenticate using your client credentials:
\nUsing basic auth with the client id as username and secret as password
\nwith parameters ‘client_id` and `client_secret`
\nThis endpoint will always return a 200 response, as per RFC7009.
\n","errors":[{"code":403,"description":"Forbidden","metadata":["OAuth2 Error"]}],"params":[{"name":"token","full_name":"token","description":"\nThe access token to be revoked
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST application/x-www-form-urlencoded:\n\ncurl -d 'token=ACCESS_TOKEN_TO_EXPIRE' -X POST -u 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' https://api.rightsignature.com/oauth/revoke\n\nRESPONSE:\n{}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"archived_documents":{"doc_url":"/documentation/resources/v2/archived_documents","id":"archived_documents","api_url":"/public/v2/","name":"Archived documents","short_description":"Retrieve Archived Documents and data","full_description":"","version":"v2","formats":["json"],"metadata":{"author":{"name":"RightSignature","contact":"support@rightsignature.com"},"last_modified":"04-21-2020"},"methods":[{"doc_url":"/documentation/resources/v2/archived_documents/find_by_original_guid","name":"find_by_original_guid","apis":[{"api_url":"/public/v2/archived_documents_by_original_guid/:original_guid","http_method":"GET","short_description":"Return data for a specific Archived Document (legacy RS)","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":401,"description":"Can't find archived document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to archived document.","metadata":null}],"params":[{"name":"original_guid","full_name":"original_guid","description":"\nArchived Document Original GUID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /public/{version}/archived_documents_by_original_guid/3X6C3WIRL4L4NU3D8C4KFG\n200\n{\n \"archived_document\": {\n \"id\": \"e4bce54d-8b2a-48be-8f0c-fecb1262b433\",\n \"name\": \"teada\",\n \"original_guid\": \"3X6C3WIRL4L4NU3D8C4KFG\",\n \"document_state\": \"executed\",\n \"document_sent_at\": \"2020-04-22T00:55:02.000-07:00\",\n \"document_executed_at\": \"2020-04-22T00:55:14.000-07:00\",\n \"document_expires_at\": \"2020-05-22T17:00:00.000-07:00\",\n \"sender_email\": \"test@test.com\",\n \"signers\": [\n {\n \"id\": \"DGH4XHJ762ZH436WTSSVB7\",\n \"email\": \"test@test.com\",\n \"name\": \"Ad\",\n \"role_name\": \"A\",\n \"status\": \"signed\",\n \"message\": \"\",\n \"sequence\": 1,\n \"viewed_at\": \"2020-04-22T00:55:03-07:00\",\n \"signed_at\": \"2020-04-22T00:55:14-07:00\",\n \"document_passcode\": null,\n \"document_passcode_question\": null,\n \"dismiss_reminders\": false,\n \"legacy_browser_rendered\": \"\",\n \"email_bounced?\": false,\n \"has_previously_signed\": false,\n \"is_current_user\": null,\n \"reminders_remaining\": 0\n }\n ],\n \"signed_pdf_url\": \"https://s3.amazonaws.com/dev.rightsignature.com/assets/5/sample-signed.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=OKe5hTNNEu%2FPqq38tPYSlLnY9ZM%3D\",\n \"page_images\": [\n {\n \"page_number\": 1,\n \"thumbnail\": \"https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_p1_t.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=SYCkPvStWWX%2BUfzoYR5fJxcqoaw%3D\",\n \"original\": \"https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_s_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=ghXHzDDPklzy%2FvmGxLXcN215KjA%3D\"\n },\n {\n \"page_number\": 2,\n \"thumbnail\": \"https://s3.amazonaws.com/dev.rightsignature.com/assets/5/a_5_a3e71d0d361047a688b8d3ea58aefcb4_p2_t.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1587637585&Signature=Ev69OFmJAqMjEuP7B3xo4iyuQKs%3D\",\n \"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\"\n }\n ],\n \"tags\": {\n \"legacy\": \"\"\n },\n \"image_width\": 675,\n \"image_height\": 874,\n \"file_attachments\": [],\n \"cc_parties\": [],\n \"audits\": [\n {\n \"id\": 34,\n \"payload\": \"All parties have signed document. Signed copies sent to: Ad.\",\n \"user_id\": 2,\n \"metadata\": {\n \"keyword\": \"executed\"\n },\n \"account_id\": 2,\n \"created_at\": \"2020-04-22T00:55:14.000-07:00\",\n \"ip_address\": null,\n \"document_id\": 5\n },\n {\n \"id\": 31,\n \"payload\": \"Document created by Ad (test@test.com).\",\n \"user_id\": 2,\n \"metadata\": {\n \"keyword\": \"created\"\n },\n \"account_id\": 2,\n \"created_at\": \"2020-04-22T00:55:02.000-07:00\",\n \"ip_address\": \"10.0.2.2\",\n \"document_id\": 5\n },\n {\n \"id\": 33,\n \"payload\": \"Document signed by Ad (test@test.com) with drawn signature.\",\n \"user_id\": 2,\n \"metadata\": {\n \"keyword\": \"signed\"\n },\n \"account_id\": 2,\n \"created_at\": \"2020-04-22T00:55:14.000-07:00\",\n \"ip_address\": \"10.0.2.2\",\n \"document_id\": 5\n },\n {\n \"id\": 32,\n \"payload\": \"Document viewed by Ad (test@test.com).\",\n \"user_id\": 2,\n \"metadata\": {\n \"keyword\": \"viewed\"\n },\n \"account_id\": 2,\n \"created_at\": \"2020-04-22T00:55:03.000-07:00\",\n \"ip_address\": \"10.0.2.2\",\n \"document_id\": 5\n }\n ],\n \"shared_with\": [],\n \"user_id\": \"5f83d219-bbba-4bc3-a933-170543a7524e\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"documents":{"doc_url":"/documentation/resources/v2/documents","id":"documents","api_url":"/public/v2/","name":"Documents","short_description":"Retrieve Documents and data","full_description":"","version":"v2","formats":["json"],"metadata":{"author":{"name":"RightSignature","contact":"support@rightsignature.com"},"last_modified":"6-14-2016"},"methods":[{"doc_url":"/documentation/resources/v2/documents/index","name":"index","apis":[{"api_url":"/public/v2/documents","http_method":"GET","short_description":"Return a list of available Documents","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[{"name":"search","full_name":"search","description":"\nA search token.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"\nDocuments from a specific template
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"state","description":"\nThe document state filter. Must be one of valid document states or comma seperated list of states. Valid document states are: draft, pending, executed, voided, expired, declined, editing
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\nThe number of documents included per page. Max is 100.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\nSpecific page of results
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /public/{version}/documents\n200\n{\n \"documents\": [],\n \"meta\": {\n \"total_pages\": 0\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/documents/show","name":"show","apis":[{"api_url":"/public/v2/documents/:id","http_method":"GET","short_description":"Return data for a specific Document","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":401,"description":"Can't find document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to document.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\nDocument ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /public/{version}/documents/4840dd4f-2c13-4395-a0e0-3577d1eed6fd\n200\n{\n \"document\": {\n \"id\": \"4840dd4f-2c13-4395-a0e0-3577d1eed6fd\",\n \"current_signer_id\": \"248883ae-a840-479f-8c2e-04de584019f9\",\n \"name\": \"Test\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:28.116-07:00\",\n \"sent_at\": \"2018-05-07T08:23:28.085-07:00\",\n \"state\": \"pending\",\n \"kba\": false,\n \"thumbnail_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=TiNQ%2BM%2BQrvpdAZ%2FmB97Qp3RChXA%3D\",\n \"sender\": {\n \"id\": \"b907e7ae-50f5-4a55-aa2d-166ac96b289e\",\n \"name\": \"Dr. Amos Kuhn\",\n \"email\": \"santos@tillman.org\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer2\",\n \"name\": \"Susie Orange\",\n \"email\": \"susie@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"c76fad94-749b-495b-b088-c184282072e4\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/c76fad94-749b-495b-b088-c184282072e4/sign?access_token=GyBD2At_UrapgeDkyccx\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/c76fad94-749b-495b-b088-c184282072e4/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 1\n },\n {\n \"role_name\": \"signer1\",\n \"name\": \"Joe Tangerine\",\n \"email\": \"joe@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"248883ae-a840-479f-8c2e-04de584019f9\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/248883ae-a840-479f-8c2e-04de584019f9/sign?access_token=esLoh2_8AB3qk17Jrpmy\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/248883ae-a840-479f-8c2e-04de584019f9/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=tOMSxHCGo2Dt63xebsIlF5mzHeE%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {},\n \"merge_field_values\": [],\n \"form_fields\": [\n {\n \"id\": \"c46aeb88-48db-417b-94e6-222662f8a2d8\",\n \"name\": \"Date Field 1\",\n \"role\": \"signer1\",\n \"value\": \"04/13/2020\",\n \"page\": 1\n },\n {\n \"id\": \"78795207-6411-4344-9d95-48fe20fdddb1\",\n \"name\": \"Text Field 1\",\n \"role\": \"signer1\",\n \"value\": \"FooBar\",\n \"page\": 1\n }\n ],\n \"embed_codes\": null,\n \"in_person\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"identity_method\": \"email\",\n \"passcode_pin_enabled\": false,\n \"original_file_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/original/78d43ec7-cd6d-4c98-9b87-8cae71a907b5/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=Fv%2FmnWCp2mk%2BIVysk0SynrpR9uc%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf\",\n \"signature_certificate_url\": \"https://rightsign-development.s3.amazonaws.com/certificates/f234d07-8545-4695-af69-e5480b56ccd6/certificate.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1533237278&Signature=ejY5en2rPPXPRPWIo50gWnZK%2F70%3D&response-content-disposition=attachment%3B%20filename%3Dhealth_insurance-certificate.pdf\",\n \"merged_document_certificate_url\": \"https://rightsign-development.s3.amazonaws.com/merged_doc_certificate/c4a2d073-145c-4c6a-b697-7ebb6cb78ce/signed-certificate.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1571378681&Signature=oEL38fvoU3LhlghNg4ndHquLXtM%3D&response-content-disposition=attachment%3B%20filename%3Ddoc-builder-signed-certificate.pdf\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/documents/share","name":"share","apis":[{"api_url":"/public/v2/documents/:id/share","http_method":"POST","short_description":"Share document. All old email recipients are removed.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Can't find document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to document.","metadata":null},{"code":422,"description":"shared_with contains invalid email address","metadata":null}],"params":[{"name":"shared_with","full_name":"shared_with","description":"\nList of email recipients to share the document with
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/documents/3831ebf2-8540-4269-bcd1-3981fa908bea/share\n{\n \"access_token\": \"a6c7d01bd1c06f24d1d40b1c1946c36762852068ed03aeb0668a4431366e1f8e\",\n \"shared_with\": [\n \"one@e.mail\",\n \"two@e.mail\"\n ],\n \"document\": {}\n}\n200\n{\n \"document\": {\n \"id\": \"3831ebf2-8540-4269-bcd1-3981fa908bea\",\n \"current_signer_id\": \"4825c9b4-8f01-4bca-b2e7-8d7158d35388\",\n \"name\": \"Test\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:29.323-07:00\",\n \"sent_at\": \"2018-05-07T08:23:29.307-07:00\",\n \"state\": \"pending\",\n \"thumbnail_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=j%2FKSG%2BHyxNiqJ5dJ3m9qSqDMvf8%3D\",\n \"sender\": {\n \"id\": \"433ec691-b661-4103-9721-e12a81f43ded\",\n \"name\": \"King Lind\",\n \"email\": \"alphonso@kihn.io\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer2\",\n \"name\": \"Susie Orange\",\n \"email\": \"susie@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"821e0abc-48d0-4ab5-9ea8-133a3dddfcf9\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/sign?access_token=yG2Pkkz3FvhuxKnPqNAf\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 1\n },\n {\n \"role_name\": \"signer1\",\n \"name\": \"Joe Tangerine\",\n \"email\": \"joe@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"4825c9b4-8f01-4bca-b2e7-8d7158d35388\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/sign?access_token=VySRyWxzdsrh5mA7p88A\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=MhjGt7MiHDHwzEG4AdZ2vJTzKhg%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {},\n \"merge_field_values\": [],\n \"embed_codes\": null,\n \"in_person\": false,\n \"shared_with\": [\n \"one@e.mail\",\n \"two@e.mail\"\n ],\n \"identity_method\": \"email\",\n \"passcode_pin_enabled\": false,\n \"original_file_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/original/59748f53-c244-4c05-8a42-a325e0570bf3/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=Xc6dIN5FsZAKVpCF8anl91Zt0cI%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/documents/update_tags","name":"update_tags","apis":[{"api_url":"/public/v2/documents/:id/update_tags","http_method":"POST","short_description":"Update the tags on a given document. All old tags are removed.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Can't find document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to document.","metadata":null},{"code":422,"description":"Hash contains empty keys","metadata":null}],"params":[{"name":"tags","full_name":"tags","description":"\nKey value tags for categorization
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/documents/8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b/update_tags\n{\n \"access_token\": \"f60307b600e8bd2dfaba3a106d54bfbbfd0782cf9d819e27bce9d2fd7cb65226\",\n \"tags\": {\n \"testing\": \"one\",\n \"single\": null\n },\n \"document\": {\n \"tags\": {\n \"testing\": \"one\",\n \"single\": null\n }\n }\n}\n200\n{\n \"document\": {\n \"id\": \"8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b\",\n \"current_signer_id\": \"e33b0297-9896-4d29-8257-926ecc973da8\",\n \"name\": \"Test\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:29.880-07:00\",\n \"sent_at\": \"2018-05-07T08:23:29.861-07:00\",\n \"state\": \"pending\",\n \"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\",\n \"sender\": {\n \"id\": \"a0068e99-8b25-4f43-ad2f-0fd4f06aac9d\",\n \"name\": \"Remington Lubowitz\",\n \"email\": \"lon@carroll.co\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer2\",\n \"name\": \"Susie Orange\",\n \"email\": \"susie@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"cb6f89ab-181f-485e-8d51-eadff36dbd71\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/sign?access_token=xKTvz4bynLVoBHrNnLRx\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 1\n },\n {\n \"role_name\": \"signer1\",\n \"name\": \"Joe Tangerine\",\n \"email\": \"joe@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"e33b0297-9896-4d29-8257-926ecc973da8\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/e33b0297-9896-4d29-8257-926ecc973da8/sign?access_token=SBH7ZiLa3D4kZRahjTE6\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/e33b0297-9896-4d29-8257-926ecc973da8/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {\n \"testing\": \"one\",\n \"single\": null\n },\n \"merge_field_values\": [],\n \"embed_codes\": null,\n \"in_person\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"identity_method\": \"email\",\n \"passcode_pin_enabled\": false,\n \"original_file_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/original/5b73cc43-0f3f-4f2f-9b02-a617fa6b1f72/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=F5WeH34v5jPGbrtVEe96D%2F%2FPXMw%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/documents/void","name":"void","apis":[{"api_url":"/public/v2/documents/:id/void","http_method":"POST","short_description":"Void a Document","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":401,"description":"Can't find document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to document.","metadata":null},{"code":401,"description":"Cannot void a document that is not pending or draft.","metadata":null}],"params":[],"returns":[],"examples":["POST /public/{version}/documents/e1858e4b-a378-40b3-b505-ad7ce18aa11f/void\n{\n \"document\": {}\n}\n200\n{\n \"document\": {\n \"status\": \"Voided draft document.\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/documents/update_pin","name":"update_pin","apis":[{"api_url":"/public/v2/documents/:id/update_pin","http_method":"PUT","short_description":"Updates the document PIN","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Can't find document.","metadata":null},{"code":401,"description":"Can't find user.","metadata":null},{"code":401,"description":"No ACLs tying user to document.","metadata":null},{"code":422,"description":"Hash contains empty keys","metadata":null}],"params":[{"name":"pin","full_name":"pin","description":"\nDocument pin. Must be between 10000 and 99999
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/documents/37f8bf7f-b57a-4774-998a-cbf7a8cd8367/update_pin\n{\n \"access_token\": \"bec095efd15e463077ae678b4a6ac4d3b07961be58d7f8e1216a573c3be71aaf\",\n \"pin\": \"12345\",\n \"document\": {}\n}\n200\n{\n \"document\": {\n \"id\": \"37f8bf7f-b57a-4774-998a-cbf7a8cd8367\",\n \"current_signer_id\": \"f55f6dfc-2acd-488f-a386-9e5b98ed5a11\",\n \"name\": \"Test\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:30.517-07:00\",\n \"sent_at\": \"2018-05-07T08:23:30.493-07:00\",\n \"state\": \"pending\",\n \"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\",\n \"sender\": {\n \"id\": \"bb1853a5-6e20-49d0-80fd-618b4743639b\",\n \"name\": \"Elizabeth Sauer\",\n \"email\": \"kaylee@daniel.biz\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer2\",\n \"name\": \"Susie Orange\",\n \"email\": \"susie@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"4ab3c881-3654-4e45-a889-a972a803bca8\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/4ab3c881-3654-4e45-a889-a972a803bca8/sign?access_token=n1zQmxzV3qbcoU4kmP-n\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/4ab3c881-3654-4e45-a889-a972a803bca8/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 1\n },\n {\n \"role_name\": \"signer1\",\n \"name\": \"Joe Tangerine\",\n \"email\": \"joe@citrix.com\",\n \"status\": \"pending\",\n \"id\": \"f55f6dfc-2acd-488f-a386-9e5b98ed5a11\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/sign?access_token=nys8UFjgFrPoypgD5oYf\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/reminders\",\n \"message\": \"Please sign.\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {},\n \"merge_field_values\": [],\n \"embed_codes\": null,\n \"in_person\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"identity_method\": \"email\",\n \"passcode_pin_enabled\": false,\n \"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\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"reusable_template_tags":{"doc_url":"/documentation/resources/v2/reusable_template_tags","id":"reusable_template_tags","api_url":"/public/v2/","name":"Reusable template tags","short_description":"CRUD functions on reusable template tags","full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/documentation/resources/v2/reusable_template_tags/show","name":"show","apis":[{"api_url":"/public/v2/reusable_templates/:reusable_template_id/tags","http_method":"GET","short_description":"Show all tags for a reusable template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_template_tags/create","name":"create","apis":[{"api_url":"/public/v2/reusable_templates/:reusable_template_id/tags","http_method":"POST","short_description":"Add new tags for a reusable template. All old tags are removed","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"tag_name","full_name":"tags[tag_name]","description":"\nTag name is required
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"tags[value]","description":"\nOptional value for the tag
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_template_tags/update","name":"update","apis":[{"api_url":"/public/v2/reusable_templates/:reusable_template_id/tags","http_method":"PATCH","short_description":"Add/update tags for a reusable template.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"tag_name","full_name":"tags[tag_name]","description":"\nTag name is required
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"tags[value]","description":"\nOptional value for the tag
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_template_tags/destroy","name":"destroy","apis":[{"api_url":"/public/v2/reusable_templates/:reusable_template_id/tags","http_method":"DELETE","short_description":"Delete a tag from a reusable template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[{"name":"tag","full_name":"tag","description":"\nTag name is required
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"reusable_templates":{"doc_url":"/documentation/resources/v2/reusable_templates","id":"reusable_templates","api_url":"/public/v2/","name":"Reusable templates","short_description":"Clone and send standardized documents for signature","full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/documentation/resources/v2/reusable_templates/show","name":"show","apis":[{"api_url":"/public/v2/reusable_templates/:id","http_method":"GET","short_description":"Return data for a specific Reusable Template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":401,"description":"Can't find Reusable Template.","metadata":null},{"code":401,"description":"Unauthorized account for Reusable Template.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\nReusable Template ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /public/{version}/reusable_templates/f7b2a464-9c41-47fa-8b1e-bdee683713de\n200\n{\n \"reusable_template\": {\n \"id\": \"f7b2a464-9c41-47fa-8b1e-bdee683713de\",\n \"name\": \"Test\",\n \"creator\": {\n \"name\": \"Althea Hirthe\",\n \"email\": \"ariel@dubuque.biz\"\n },\n \"expires_in\": 30,\n \"signer_sequencing\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"distribution_method\": \"email\",\n \"identity_method\": \"email\",\n \"kba\": false,\n \"passcode\": false,\n \"filename\": \"application.pdf\",\n \"tags\": {},\n \"user_id\": \"c9d1d867-4ea6-4245-8b31-0db643db1dde\",\n \"roles\": [\n {\n \"name\": \"signer1\",\n \"sequence\": 0,\n \"message\": \"Please sign.\",\n \"signer_name\": \"\",\n \"signer_email\": \"\"\n },\n {\n \"name\": \"signer2\",\n \"sequence\": 1,\n \"message\": \"Please sign.\",\n \"signer_name\": \"\",\n \"signer_email\": \"\"\n }\n ],\n \"merge_field_components\": [],\n \"created_at\": \"2018-05-07T08:23:31.389-07:00\",\n \"updated_at\": \"2018-05-07T08:23:31.389-07:00\",\n \"thumbnail_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793011&Signature=az2LSkGPzh4fchAdgQm0ZnVotoY%3D\",\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793011&Signature=fqGRitUbgweH%2BulIbHme0fO0ekI%3D\"\n ]\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_templates/index","name":"index","apis":[{"api_url":"/public/v2/reusable_templates","http_method":"GET","short_description":"Return a list of available Reusable Templates","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[{"name":"search","full_name":"search","description":"\nA search token.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\nThe number of reusable templates included per result page
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\nSpecific page of results
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"schema","full_name":"schema","description":"\nschema
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":false,"validations":[]}],"returns":[],"examples":["GET /public/{version}/reusable_templates\n200\n{\n \"reusable_templates\": [],\n \"meta\": {\n \"total_pages\": 0\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_templates/prepare_document","name":"prepare_document","apis":[{"api_url":"/public/v2/reusable_templates/:id/prepare_document","http_method":"POST","short_description":"Prepare a document to be sent from a Reusable Template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Can't find Reusable Template.","metadata":null},{"code":401,"description":"Unauthorized account for Reusable Template.","metadata":null},{"code":422,"description":"The role name supplied (A name for the document you are sending
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shared_with","full_name":"shared_with","description":"\nList of email recipients to share the document with
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\nA message for all signers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"redirect_url","full_name":"redirect_url","description":"\nA URL to redirect to after sending the document. Must start with http:// or https://. Example: example.com/redirect
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"callback_url","full_name":"callback_url","description":"\nDocument callback url. The URL will receive a POST for each of the following document events: created, viewed, signed, executed, voided, declined. Note that due to the asynchronous nature of processing, the order in which the document callbacks are sent is not guaranteed. Only HTTP ports 80, 8000-8099, 3000-3009 and HTTPS port 443 is supported. Basic auth is also supported. Ex. “me:pass@yourhost.example:8001/callback”.
ex. callback when document is viewed {
\n\n"callbackType":"Document",\n"id":"edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2",\n"event":"viewed",\n"documentState":"pending",\n"createdAt":"2016-11-14T13:45:23.199-08:00"\n\n
}
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\nDocument signers
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"roles[name]","description":"\nRole name. For text tags, the role name in the request must correspond to the recipient name given as the second argument (name) in the text tag. When signer sequencing is enabled, the role name must match the signer name set on the template.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_name","full_name":"roles[signer_name]","description":"\nSigner name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_email","full_name":"roles[signer_email]","description":"\nSigner email
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_omitted","full_name":"roles[signer_omitted]","description":"\nA signer can be omitted if set to true and if signer_sequencing is enabled
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_sender","full_name":"roles[is_sender]","description":"\nIs signer the owner of document?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"roles[message]","description":"\nCustom message to signer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"expires_in","full_name":"expires_in","description":"\nDocument expiration. Must be between 1 and 365 days
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"pin","description":"\nDocument pin. Must be between 10000 and 99999
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_templates/send_document","name":"send_document","apis":[{"api_url":"/public/v2/reusable_templates/:id/send_document","http_method":"POST","short_description":"Clone and send a Document from a Reusable Template","deprecated":null}],"formats":["json"],"full_description":"\nSends a document from reusable templates with the specified id.
param merge_field_identifier and sub-param name has been added, see Params Section below to know more.
A name for the document you are sending
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shared_with","full_name":"shared_with","description":"\nList of email recipients to share the document with
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\nA message for all signers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_person","full_name":"in_person","description":"\nWhether the document should be signed in person
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"callback_url","full_name":"callback_url","description":"\nDocument callback url. The URL will receive a POST for each of the following document events: created, viewed, signed, executed, voided, declined. Note that due to the asynchronous nature of processing, the order in which the document callbacks are sent is not guaranteed. Only HTTP ports 80, 8000-8099, 3000-3009 and HTTPS port 443 is supported. Basic auth is also supported. Ex. “me:pass@yourhost.example:8001/callback”.
ex. callback when document is viewed {
\n\n"callbackType":"Document",\n"id":"edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2",\n"event":"viewed",\n"documentState":"pending",\n"createdAt":"2016-11-14T13:45:23.199-08:00"\n\n
}
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\nDocument signers
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"roles[name]","description":"\nRole name. For text tags, the role name in the request must correspond to the recipient name given as the second argument (name) in the text tag. When signer sequencing is enabled, the role name must match the signer name set on the template.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_name","full_name":"roles[signer_name]","description":"\nSigner name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_email","full_name":"roles[signer_email]","description":"\nSigner email
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_omitted","full_name":"roles[signer_omitted]","description":"\nA signer can be omitted if set to true and if signer_sequencing is enabled
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_sender","full_name":"roles[is_sender]","description":"\nIs signer the owner of document?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"roles[message]","description":"\nCustom message to signer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"merge_field_identifier","full_name":"merge_field_identifier","description":"\nMerge Field Identifier. By specifying it to “name” API user can map merge field value with the name instead of merge field id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:id, name.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"merge_field_values","full_name":"merge_field_values","description":"\nMerge Fields
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"merge_field_values[id]","description":"\nMerge Field ID
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"merge_field_values[name]","description":"\nMerge Field Name. This is the name provided to the merge field on the webapp, while creating the template. If it matches more than one merge field component in template all of them will be filled with the same value
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"merge_field_values[value]","description":"\nMerge Field value. If the merge field is a date, the value should be in yyyy/mm/dd or yyyy-mm-dd format.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"expires_in","full_name":"expires_in","description":"\nDocument expiration. Must be between 1 and 365 days
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"pin","description":"\nDocument pin. Must be between 10000 and 99999
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kba","full_name":"kba","description":"\nEnable KBA on the document (applicable for KBA enabled plans)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/reusable_templates/fcc2517e-c596-4d91-9f59-112a292eb643/send_document\n{\n \"access_token\": \"6732e93a3f4647b8f33260eba68041cf97542a224b687de189920644172c3bcb\",\n \"message\": \"Please sign this\",\n \"expires_in\": 30,\n \"roles\": [\n {\n \"name\": \"signer1\",\n \"signer_email\": \"geoff@sample.com\",\n \"signer_name\": \"geoff\"\n }\n ],\n \"name\": \"This is the name of a document\",\n \"reusable_template\": {\n \"roles\": [\n {\n \"name\": \"signer1\",\n \"signer_email\": \"geoff@sample.com\",\n \"signer_name\": \"geoff\"\n }\n ]\n }\n}\n200\n{\n \"document\": {\n \"id\": \"526819c7-45df-4b71-82c0-6aab3ac1a1dc\",\n \"current_signer_id\": \"813e6fa2-650c-4da6-b27f-a3861967f20f\",\n \"name\": \"This is the name of a document\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:31.934-07:00\",\n \"sent_at\": \"2018-05-07T08:23:31.961-07:00\",\n \"state\": \"pending\",\n \"thumbnail_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793011&Signature=az2LSkGPzh4fchAdgQm0ZnVotoY%3D\",\n \"sender\": {\n \"id\": \"df5c5874-6613-4a9b-8ef6-34e2a932b03a\",\n \"name\": \"Prince Effertz\",\n \"email\": \"jayda@gibsonkuhic.name\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer1\",\n \"name\": \"geoff\",\n \"email\": \"geoff@sample.com\",\n \"status\": \"pending\",\n \"id\": \"813e6fa2-650c-4da6-b27f-a3861967f20f\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/813e6fa2-650c-4da6-b27f-a3861967f20f/sign?access_token=yWSRRzysutShj15ydX4h\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/813e6fa2-650c-4da6-b27f-a3861967f20f/reminders\",\n \"message\": \"Please sign this\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793012&Signature=7LwQlkS5zTna5gDFhuM5y0J307c%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {},\n \"merge_field_values\": [],\n \"embed_codes\": null,\n \"in_person\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"identity_method\": \"email\",\n \"passcode_pin_enabled\": false,\n \"original_file_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/original/af7d073d-74eb-4539-8412-5a7c4e262cd5/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793012&Signature=fv5yF%2BLySuyCjOCr%2FcZBq7L7aDs%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_templates/merge_and_send_document","name":"merge_and_send_document","apis":[{"api_url":"/public/v2/reusable_templates/:id/merge_and_send_document","http_method":"POST","short_description":"Merge and Send Document","deprecated":null}],"formats":["json"],"full_description":"\nFill the data fields supplied into merge fields and sends out a document from reusable templates with the specified id.
A name for the document you are sending
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shared_with","full_name":"shared_with","description":"\nList of email recipients to share the document with
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\nA message for all signers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_person","full_name":"in_person","description":"\nWhether the document should be signed in person
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"callback_url","full_name":"callback_url","description":"\nDocument callback url. The URL will receive a POST for each of the following document events: created, viewed, signed, executed, voided, declined. Note that due to the asynchronous nature of processing, the order in which the document callbacks are sent is not guaranteed. Only HTTP ports 80, 8000-8099, 3000-3009 and HTTPS port 443 is supported. Basic auth is also supported. Ex. “me:pass@yourhost.example:8001/callback”.
ex. callback when document is viewed {
\n\n"callbackType":"Document",\n"id":"edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2",\n"event":"viewed",\n"documentState":"pending",\n"createdAt":"2016-11-14T13:45:23.199-08:00"\n\n
}
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\nDocument signers
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"roles[name]","description":"\nRole name. For text tags, the role name in the request must correspond to the recipient name given as the second argument (name) in the text tag. When signer sequencing is enabled, the role name must match the signer name set on the template.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_name","full_name":"roles[signer_name]","description":"\nSigner name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_email","full_name":"roles[signer_email]","description":"\nSigner email
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_omitted","full_name":"roles[signer_omitted]","description":"\nA signer can be omitted if set to true and if signer_sequencing is enabled
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_sender","full_name":"roles[is_sender]","description":"\nIs signer the owner of document?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"roles[message]","description":"\nCustom message to signer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"merge_field_data","full_name":"merge_field_data","description":"\nMerge fields data
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\nDocument expiration. Must be between 1 and 365 days
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\nDocument expiration date time. An expires_at date time should not be earlier than the current date time, and it must be in the UTC time format.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"pin","description":"\nDocument pin. Must be between 10000 and 99999
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kba","full_name":"kba","description":"\nEnable KBA on the document (applicable for KBA enabled plans)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":false},{"doc_url":"/documentation/resources/v2/reusable_templates/embed_document","name":"embed_document","apis":[{"api_url":"/public/v2/reusable_templates/:id/embed_document","http_method":"POST","short_description":"Embed a cloned document from a Reusable Template","deprecated":null}],"formats":["json"],"full_description":"\nEmbeds a document from reusable templates with the specified id.
param merge_field_identifier and sub-param name has been added, see Params Section below to know more.
A name for the document you are sending
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shared_with","full_name":"shared_with","description":"\nList of email recipients to share the document with
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\nA message for all signers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\nDocument signers
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"roles[name]","description":"\nRole name. For text tags, role name must match.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_name","full_name":"roles[signer_name]","description":"\nSigner name
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_email","full_name":"roles[signer_email]","description":"\nSigner email.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_sender","full_name":"roles[is_sender]","description":"\nIs signer the owner of document?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"roles[message]","description":"\nCustom message to signer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"api_embed_width","full_name":"api_embed_width","description":"\nEmbed width
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_embed_height","full_name":"api_embed_height","description":"\nEmbed height
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"merge_field_identifier","full_name":"merge_field_identifier","description":"\nMerge Field Identifier. By specifying it to “name” API user can map merge field value with the name instead of merge field id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:id, name.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"merge_field_values","full_name":"merge_field_values","description":"\nMerge Fields
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"merge_field_values[id]","description":"\nMerge Field ID
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"merge_field_values[name]","description":"\nMerge Field Name. This is the name provided to the merge field on the webapp, while creating the template. If it matches more than one merge field component in template all of them will be filled with the same value
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"merge_field_values[value]","description":"\nMerge Field value. If the merge field is a date, the value should be in yyyy/mm/dd or yyyy-mm-dd format.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"expires_in","full_name":"expires_in","description":"\nDocument expiration. Must be between 1 and 365 days
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"tags","description":"\nOptional key value tags for categorization
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/reusable_templates/e011e65a-79a1-488a-b875-89a569a48da7/embed_document\n{\n \"access_token\": \"a82490f7708d949b449453a17705b191cd6f37b5cff7e3bd8cf6b92d88ea48f4\",\n \"message\": \"Please sign this\",\n \"expires_in\": 30,\n \"roles\": [\n {\n \"name\": \"signer1\",\n \"signer_name\": \"geoff\"\n }\n ],\n \"name\": \"This is the name of a document\",\n \"api_embed_width\": \"706\",\n \"api_embed_height\": \"500\",\n \"reusable_template\": {\n \"roles\": [\n {\n \"name\": \"signer1\",\n \"signer_name\": \"geoff\"\n }\n ]\n }\n}\n200\n{\n \"document\": {\n \"id\": \"25b47840-0925-4241-99b9-7486362decbd\",\n \"current_signer_id\": \"4262bfbe-032e-41fe-a899-3afacbbe59e7\",\n \"name\": \"This is the name of a document\",\n \"filename\": \"application.pdf\",\n \"executed_at\": null,\n \"expired_at\": \"2018-06-06T08:23:32.224-07:00\",\n \"sent_at\": \"2018-05-07T08:23:32.253-07:00\",\n \"state\": \"pending\",\n \"thumbnail_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793012&Signature=%2BuRBmk3S1Ss4viFAbhfdcmVLX08%3D\",\n \"sender\": {\n \"id\": \"ceb73f25-0f0c-460b-9950-d8c1e4f8d925\",\n \"name\": \"Stuart Ziemann\",\n \"email\": \"everardo_schimmel@lindgrenfeil.com\",\n \"signer\": false\n },\n \"recipients\": [\n {\n \"role_name\": \"signer1\",\n \"name\": \"geoff\",\n \"email\": null,\n \"status\": \"pending\",\n \"id\": \"4262bfbe-032e-41fe-a899-3afacbbe59e7\",\n \"sign_url\": \"https://secure.rs.dev:3000/signers/4262bfbe-032e-41fe-a899-3afacbbe59e7/sign?access_token=vcePnuyc8Zj3NfDD9Hh5\",\n \"remind_url\": \"https://api.rs.dev:3002/public/{version}/signers/4262bfbe-032e-41fe-a899-3afacbbe59e7/reminders\",\n \"message\": \"Please sign this\",\n \"sequence\": 0\n }\n ],\n \"audits\": [],\n \"page_image_urls\": [\n \"https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793012&Signature=7LwQlkS5zTna5gDFhuM5y0J307c%3D\"\n ],\n \"signed_pdf_url\": null,\n \"tags\": {},\n \"merge_field_values\": [],\n \"embed_codes\": [\n {\n \"embed_code\": \"\",\n \"signer_email\": null,\n \"signer_role_name\": \"signer1\"\n }\n ],\n \"in_person\": false,\n \"shared_with\": [\n \"test@test.com\"\n ],\n \"identity_method\": \"none\",\n \"passcode_pin_enabled\": false,\n \"original_file_url\": \"https://rightsign-development.s3.amazonaws.com/base_files/original/31262dd7-724b-48f0-a642-9c313d680165/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793012&Signature=PyyMOhZAybdz6gunjEkVvKA4vLE%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf\"\n }\n}","POST /public/{version}/reusable_templates/df643e6f-7a61-437b-b225-c32f0f83f9c9/embed_document\n{\n \"access_token\": \"33175d0e79a201b002959eced15f857e31ca7a45574f3db9738989d939a143af\",\n \"message\": \"Please sign this\",\n \"expires_in\": 30,\n \"roles\": [\n {\n \"name\": \"signer1\"\n }\n ],\n \"name\": \"This is the name of a document\",\n \"api_embed_width\": \"706\",\n \"api_embed_height\": \"500\",\n \"reusable_template\": {\n \"roles\": [\n {\n \"name\": \"signer1\"\n }\n ]\n }\n}\n422\n{\n \"error\": \"Signer Name is required\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/reusable_templates/destroy","name":"destroy","apis":[{"api_url":"/public/v2/reusable_templates/:id","http_method":"DELETE","short_description":"Delete a Reusable Template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":404,"description":"Can't find Reusable Template.","metadata":null},{"code":401,"description":"Unauthorized account for Reusable Template.","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\nReusable Template ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sending_requests":{"doc_url":"/documentation/resources/v2/sending_requests","id":"sending_requests","api_url":"/public/v2/","name":"Sending requests","short_description":"Send custom documents for signature","full_description":"","version":"v2","formats":["json"],"metadata":{"author":{"name":"RightSignature","contact":"support@rightsignature.com"},"last_modified":"12-14-2021"},"methods":[{"doc_url":"/documentation/resources/v2/sending_requests/show","name":"show","apis":[{"api_url":"/public/v2/sending_requests/:id","http_method":"GET","short_description":"Return the processing status of an existing Sending Request","deprecated":null}],"formats":["json"],"full_description":"\nReturns the status of the sending request.
\n","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":404,"description":"Sending Request not found.","metadata":null},{"code":404,"description":"Sending Request 'Sending Request id
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /public/{version}/sending_requests/94816d85-f003-461d-bd23-021df5814e54\n200\n{\n \"id\": \"94816d85-f003-461d-bd23-021df5814e54\",\n \"status\": \"waiting_for_file\",\n \"status_message\": null,\n \"upload_url\": \"https://rightsignature-sr-development.s3.amazonaws.com/public_api/sending_requests/94816d85-f003-461d-bd23-021df5814e54/test.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJSRMQNOZ6XOBJZ4A%2F20180507%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180507T152332Z&X-Amz-Expires=3600&X-Amz-Signature=444cef94d31991e1f8c4d2de2423c9b2cd8bbd286a51fc2b494307c3cea7c02f&X-Amz-SignedHeaders=Host&x-amz-acl=private\",\n \"document_template_id\": null,\n \"created_at\": \"2018-05-07T08:23:32.620-07:00\",\n \"updated_at\": \"2018-05-07T08:23:32.620-07:00\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/sending_requests/create","name":"create","apis":[{"api_url":"/public/v2/sending_requests","http_method":"POST","short_description":"Create a Sending Request","deprecated":null}],"formats":["json"],"full_description":"\nThis generates a Sending Request for a one-off Document with a file.
\n\nThe request will contain the file and Document attributes, that will be delivered after the file is uploaded.
\n\nThe response will contain a upload_url where you can PUT to upload the file.
It is important to call api.rightsignature.com/public/{version}/sending_requests/:id/uploaded after the file is uploaded, to trigger the Document creation.
\n\nTo upload the file, do a PUT to the response’s upload_url with the file in the body. Ex. response
{\n"sending_request": {\n "id": "09001350-1853-471c-955a-abb7d3120aa1",\n "upload_url": "https://rightsignature-sr-production.s3.amazonaws.comsending_requests/dbc73bba-2fe6-4a73-a227-3d221e97fa4a/testSR.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ6XOWM37KL6IPHHA%2F20160811%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20160811T192204Z&X-Amz-Expires=3600&X-Amz-Signature=9016aea2d753c1bc07e75b27c472cbced86f3f30957152c96aec1eae01b9d191&X-Amz-SignedHeaders=Host&x-amz-acl=private",\n "document_template_id":null,\n "created_at":"2016-08-10T18:57:29.400-07:00",\n "updated_at":"2016-08-10T18:57:29.400-07:00"\n}\n\n}
\n\nEx. curl command to upload location file test_post.pdf
curl -v -X PUT -F 'file=@test_post.pdf' 'https://rightsignature-sr-production.s3.amazonaws.comsending_requests/dbc73bba-2fe6-4a73-a227-3d221e97fa4a/testSR.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ6XOWM37KL6IPHHA%2F20160811%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20160811T192204Z&X-Amz-Expires=3600&X-Amz-Signature=9016aea2d753c1bc07e75b27c472cbced86f3f30957152c96aec1eae01b9d191&X-Amz-SignedHeaders=Host&x-amz-acl=private'\n\n
After uploading, you will need to do a POST to api.rightsignature.com/public/{version}/sending_requests/:id/uploaded.
\n","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":404,"description":"User account is not enabled.","metadata":null},{"code":404,"description":"User has reached document limit.","metadata":null}],"params":[{"name":"file","full_name":"file","description":"\nUpload file information
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"file[name]","description":"\nFilename withe extension
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source","full_name":"file[source]","description":"\nSource of file. Only ‘upload’ is supported.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:upload, remote_file.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"document","full_name":"document","description":"\nDocument information
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"document[name]","description":"\nDocument name
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_sequencing","full_name":"document[signer_sequencing]","description":"\nSend to signers in specified sequence.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personalized_messages","full_name":"document[personalized_messages]","description":"\nUse custom messages per signer. Specified in ‘roles’ attribute.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shared_with","full_name":"document[shared_with]","description":"\nArray of emails to CC document.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"identity_method","full_name":"document[identity_method]","description":"\nHow to authenticate signers (email | none).
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:email, none.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"callback_url","full_name":"document[callback_url]","description":"\nDocument callback url. The URL will receive a POST for each of the following document events: created, viewed, signed, executed, voided, declined. Note that due to the asynchronous nature of processing, the order in which the document callbacks are sent is not guaranteed. Only HTTP ports 80, 8000-8099, 3000-3009 and HTTPS port 443 is supported. Basic auth is also supported. Ex. “me:pass@yourhost.example:8001/callback”.
Note: This is different from the sending request callback url which receives status updates regarding the sending request itself.
\n\nex. callback when document is viewed
\n\n{\n "callbackType":"Document",\n "id":"edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2",\n "event":"viewed",\n "documentState":"pending",\n "createdAt":"2016-11-14T13:45:23.199-08:00"\n}\n\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_embedded","full_name":"document[api_embedded]","description":"\nWhether the document should be embedded.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_embed_width","full_name":"document[api_embed_width]","description":"\nEmbed width
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_embed_height","full_name":"document[api_embed_height]","description":"\nEmbed height
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"document[roles]","description":"\nDocument signers
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"document[roles][name]","description":"\nRole name. For text tags, the role name in the request must correspond to the recipient name given as the second argument (name) in the text tag. When signer sequencing is enabled, the role name must match the signer name set on the template.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_name","full_name":"document[roles][signer_name]","description":"\nSigner name
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_sender","full_name":"document[roles][is_sender]","description":"\nIs signer the owner of document?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sequence","full_name":"document[roles][sequence]","description":"\nSigner order (starting at 0), required if signer_sequencing is enabled.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"document[roles][message]","description":"\nCustom message to signer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"signer_email","full_name":"document[roles][signer_email]","description":"\nSigner email
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"expires_in","full_name":"document[expires_in]","description":"\nDocument expiration. Must be between 1 and 365 days
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"document[pin]","description":"\nDocument pin. Must be between 10000 and 99999
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"document[tags]","description":"\nOptional key value tags for categorization
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kba","full_name":"document[kba]","description":"\nEnable KBA on the document (applicable for KBA enabled plans)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"callback_url","full_name":"callback_url","description":"\nURL to receive sending request status updates. The URL will receive a POST when the sending request is sent as a document or an error occured in processing. Only HTTP ports 80, 8000-8099, 3000-3009 and HTTPS port 443 is supported. Basic auth is also supported. Ex. value: “me:pass@yourhost.example/req_callback” ex. callback when successful {
\n\n"sending_request": {\n "id": "09001350-1853-471c-955a-abb7d3120aa1",\n "status": "completed",\n "document_template_id": "733816f6-939f-4a8d-98de-55e357ab07d4",\n "created_at":"2016-08-10T18:57:29.400-07:00",\n "updated_at":"2016-08-10T19:05:11.100-07:00"\n}\n\n} ex. callback when processing fails {
\n\n"sending_request": {\n "id": "09001350-1853-471c-955a-abb7d3120aa1",\n "status": "errored",\n "status_message": "File was password protected"\n "document_template_id": null,\n "created_at":"2016-08-10T18:57:29.400-07:00",\n "updated_at":"2016-08-10T19:05:11.100-07:00"\n}\n\n}
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/sending_requests\n{\n \"file\": {\n \"name\": \"my_upload.pdf\",\n \"source\": \"upload\"\n },\n \"document\": {\n \"signer_sequencing\": false,\n \"expires_in\": 12,\n \"name\": \"Sign me\",\n \"roles\": [\n {\n \"name\": \"a\",\n \"signer_name\": \"Geoff E\",\n \"signer_email\": \"geoff@example.com\"\n }\n ]\n },\n \"sending_request\": {}\n}\n200\n{\n \"sending_request\": {\n \"id\": \"bf98b25c-a16b-4709-82fc-54034e736077\",\n \"status\": \"waiting_for_file\",\n \"status_message\": null,\n \"upload_url\": \"https://rightsignature-sr-development.s3.amazonaws.com/public_api/sending_requests/bf98b25c-a16b-4709-82fc-54034e736077/my_upload.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJSRMQNOZ6XOBJZ4A%2F20180507%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180507T152332Z&X-Amz-Expires=3600&X-Amz-Signature=6ceecd6dfcf75b208b3cfd1386d9e6cd54c8df5ad9daa648fcc37fedef70f90f&X-Amz-SignedHeaders=Host&x-amz-acl=private\",\n \"document_template_id\": null,\n \"created_at\": \"2018-05-07T08:23:32.772-07:00\",\n \"updated_at\": \"2018-05-07T08:23:32.772-07:00\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/documentation/resources/v2/sending_requests/uploaded","name":"uploaded","apis":[{"api_url":"/public/v2/sending_requests/:id/uploaded","http_method":"POST","short_description":"Create a new Sending Request to ultimately send a one-off Document","deprecated":null}],"formats":["json"],"full_description":"\nTriggers the processing of the uploaded file into a Document. The file must be completely uploaded to the Sending Request’s upload_url. Processing happens asynchronously, use api.rightsignature.com/public/v2/sending_requests/SENDING_REQUEST_ID to check the status or wait for updates if callback_url is set.
Sending Request ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"prepare_document","full_name":"prepare_document","description":"\nWhether the document should be sent or an url to be returned for preparing the document
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/sending_requests/SENDING_REQUEST_ID/uploaded\n\ncurl -H \"Accept: application/json\" -H \"Content-Type: application/json\" -X POST https://api.rightsignature.com/public/{version}/sending_requests/SENDING_REQUEST_ID/uploaded\n\n{\n \"id\": SENDING_REQUEST_ID,\n \"status\": \"processing\",\n \"status_message\": null,\n \"document_template_id\": null,\n \"created_at\": \"created date and time\",\n \"updated_at\": \"updated date and time\",\n \"document_preparation_url\": null\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"signers":{"doc_url":"/documentation/resources/v2/signers","id":"signers","api_url":"/public/v2/","name":"Signers","short_description":"Document recipients","full_description":"","version":"v2","formats":["json"],"metadata":{"author":{"name":"RightSignature","contact":"support@rightsignature.com"},"last_modified":"12-1-2016"},"methods":[{"doc_url":"/documentation/resources/v2/signers/reminders","name":"reminders","apis":[{"api_url":"/public/v2/signers/:id/reminders","http_method":"POST","short_description":"Sends a reminder email to pending signers","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null},{"code":401,"description":"User is blank.","metadata":null},{"code":401,"description":"User is not the document sender.","metadata":null},{"code":401,"description":"Document needs to be pending.","metadata":null},{"code":401,"description":"Exceeded send reminder threshold. (30 per document).","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\nSigner ID
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /public/{version}/signers/9255ea23-117b-4ac7-939e-c1a9d82d5020/reminders\n{\n \"access_token\": \"fab7e3b5ff8765ebec6b990f30a25dfb4a48887713e6f3801abc8d25a0128d99\"\n}\n200\n{\n \"reminder\": {\n \"status\": \"sent\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"users":{"doc_url":"/documentation/resources/v2/users","id":"users","api_url":"/public/v2/","name":"Users","short_description":"Document senders","full_description":"","version":"v2","formats":["json"],"metadata":{"author":{"name":"RightSignature","contact":"support@rightsignature.com"},"last_modified":"4-29-2016"},"methods":[{"doc_url":"/documentation/resources/v2/users/me","name":"me","apis":[{"api_url":"/public/v2/me","http_method":"GET","short_description":"Return information about the authenticated RightSignature User","deprecated":null}],"formats":["json"],"full_description":"\nProvides a way of getting information about the authenticated user. This will be scoped to whoever the client application was generated for.
\n","errors":[{"code":400,"description":"invalid_scope","metadata":null},{"code":400,"description":"unauthorized_client","metadata":null},{"code":401,"description":"Could not find resource owner","metadata":null},{"code":401,"description":"Resource owner is not entitled","metadata":null},{"code":401,"description":"invalid_token","metadata":null},{"code":401,"description":"Must be authenticated.","metadata":null},{"code":401,"description":"Unauthorized application.","metadata":null},{"code":422,"description":"Bad input parameter. Error message should indicate which one and why.","metadata":null}],"params":[],"returns":[],"examples":["GET /public/{version}/me\n200\n{\n \"user\": {\n \"id\": \"6fa4b1a8-dd7f-47d1-a169-792c60bea17d\",\n \"timezone\": null,\n \"name\": \"George Jetson\",\n \"email\": \"george@example.com\",\n \"company\": \"Space Camp LLC\",\n \"avatar_url\": null,\n \"can_send_documents\": true,\n \"is_grace_period\": false,\n \"cancellation_date\": null\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}