Create Sending Request
Creates a RightSignature sending request for a one-off document.
Query
Comma-separated response fields to include.
Body
Upload file information
Filename withe extension
Source of file. Only 'upload' is supported.
Document information
Document name
Send to signers in specified sequence.
Use custom messages per signer. Specified in 'roles' attribute.
Array of emails to CC document.
How to authenticate signers (email | none).
Document 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:[email protected]:8001/callback ”. Note : This is different from the sending request callback url which receives status updates regarding the sending request itself. ex. callback when document is viewed { "callbackType": "Document" , "id": "edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2" , "event": "viewed" , "documentState": "pending" , "createdAt": "2016-11-14T13:45:23.199-08:00" }
Whether the document should be embedded.
Embed width
Embed height
Document signers
Role 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.
Signer name
Is signer the owner of document?
Signer order (starting at 0), required if signer_sequencing is enabled.
Custom message to signer.
Signer email
Document expiration. Must be between 1 and 365 days
Document pin. Must be between 10000 and 99999
Optional key value tags for categorization
Enable KBA on the document (applicable for KBA enabled plans)
URL 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:[email protected]/req_callback ” ex. callback when successful { "sending_request": { "id": "09001350-1853-471c-955a-abb7d3120aa1", "status": "completed", "document_template_id": "733816f6-939f-4a8d-98de-55e357ab07d4", "created_at":"2016-08-10T18:57:29.400-07:00", "updated_at":"2016-08-10T19:05:11.100-07:00" } } ex. callback when processing fails { "sending_request": { "id": "09001350-1853-471c-955a-abb7d3120aa1", "status": "errored", "status_message": "File was password protected" "document_template_id": null, "created_at":"2016-08-10T18:57:29.400-07:00", "updated_at":"2016-08-10T19:05:11.100-07:00" } }