Request a signature for the given document.
POST {{baseUrl}}/proposals/:proposal-id/documents/signing
The endpoint initiates a signature request for the given document.
Request Body
{"documentIds"=>[{"type"=>"<string>", "value"=>"<integer>"}, {"type"=>"<string>", "value"=>"<integer>"}], "signatories"=>[{"firstName"=>"<string>", "lastName"=>"<string>", "registrationNumber"=>"<string>", "email"=>"<string>", "phone"=>"<string>", "jobTitle"=>{"id"=>"<integer>", "name"=>"<string>", "isCustom"=>"<boolean>"}, "jobTitleCustom"=>"<string>", "boardmemberId"=>"<integer>", "boardmember"=>"<boolean>", "type"=>"<string>"}, {"firstName"=>"<string>", "lastName"=>"<string>", "registrationNumber"=>"<string>", "email"=>"<string>", "phone"=>"<string>", "jobTitle"=>{"id"=>"<integer>", "name"=>"<string>", "isCustom"=>"<boolean>"}, "jobTitleCustom"=>"<string>", "boardmemberId"=>"<integer>", "boardmember"=>"<boolean>", "type"=>"<string>"}], "emailsInCC"=>"<string>", "uploadedDocument"=>{"fileContent"=>"<string>", "type"=>{"id"=>"<integer>", "code"=>"<string>", "name"=>"<string>"}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-Match | string | (Required) The If-Match HTTP request header makes the request conditional. For PUT and other modifying methods, it will only modify the resource in case the ETag indicated by the If-Match header is identical to the resource's current ETag. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"id":{"type":"\u003cstring\u003e","value":"\u003cinteger\u003e"},"documentType":{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"printOptions":[{"name":"\u003cstring\u003e","selected":"\u003cboolean\u003e"},{"name":"\u003cstring\u003e","selected":"\u003cboolean\u003e"}],"downloadAllowed":false,"downloadSignedAllowed":false,"downloadUploadedAllowed":true,"sendByEmailAllowed":false,"required":true,"received":true,"receivedDate":"2014-11-23T22:12:22.458Z","valid":false,"validationDate":"2006-03-24T00:11:07.232Z","reason":"reprehenderit enim tempor","reasonNote":"sint officia","eligibleForSigning":true,"signingEnabled":true,"sendSigningRequestAllowed":true,"canBeSignedCombined":false,"signingRequest":{"status":"AUTHORING","documentVersion":"deserunt quis","password":"tempor aute","refreshAllowed":false,"deleteAllowed":false,"downloadAllowed":true,"sendReminderAllowed":false,"senderFirstName":"magna ut","senderLastName":"qui proident labore est","senderGid":"tempor Lorem ipsum","sendDate":"2015-07-04T06:19:29.984Z","signatories":[{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","registrationNumber":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","jobTitle":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCustom":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"jobTitleCustom":"\u003cstring\u003e","boardmember":"\u003cboolean\u003e","type":"\u003cstring\u003e"},{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","registrationNumber":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","jobTitle":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCustom":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"jobTitleCustom":"\u003cstring\u003e","boardmember":"\u003cboolean\u003e","type":"\u003cstring\u003e"}]},"alias":"elit dolore","fileName":"ut proident aute"},{"id":{"type":"\u003cstring\u003e","value":"\u003cinteger\u003e"},"documentType":{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"printOptions":[{"name":"\u003cstring\u003e","selected":"\u003cboolean\u003e"},{"name":"\u003cstring\u003e","selected":"\u003cboolean\u003e"}],"downloadAllowed":true,"downloadSignedAllowed":true,"downloadUploadedAllowed":true,"sendByEmailAllowed":false,"required":true,"received":false,"receivedDate":"2017-07-04T12:53:06.673Z","valid":true,"validationDate":"1993-07-17T09:14:22.586Z","reason":"laborum mollit dolor","reasonNote":"Excepteur","eligibleForSigning":false,"signingEnabled":false,"sendSigningRequestAllowed":false,"canBeSignedCombined":true,"signingRequest":{"status":"SIGNED","documentVersion":"dol","password":"esse ull","refreshAllowed":false,"deleteAllowed":true,"downloadAllowed":true,"sendReminderAllowed":true,"senderFirstName":"veniam velit anim officia","senderLastName":"aliqua est id","senderGid":"cillum do minim","sendDate":"1972-04-06T01:54:28.846Z","signatories":[{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","registrationNumber":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","jobTitle":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCustom":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"jobTitleCustom":"\u003cstring\u003e","boardmember":"\u003cboolean\u003e","type":"\u003cstring\u003e"},{"firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","registrationNumber":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","jobTitle":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCustom":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"jobTitleCustom":"\u003cstring\u003e","boardmember":"\u003cboolean\u003e","type":"\u003cstring\u003e"}]},"alias":"aliquip esse sint consequat do","fileName":"exercitation officia occaecat "}]