Create sign request
POST https://{{api.box.com}}/2.0/sign_requests
Creates a sign request. This involves preparing a document for signing and
https://developer.box.com/reference/post-sign-requests
Request Body
{"is_document_preparation_needed"=>true, "redirect_url"=>"https://www.example.com", "declined_redirect_url"=>"https://declined-redirect.com", "are_text_signatures_enabled"=>true, "email_subject"=>"Sign Request from Acme", "email_message"=>"Hello! Please sign the document below", "are_reminders_enabled"=>true, "name"=>"name", "prefill_tags"=>[{"document_tag_id"=>"1234", "text_value"=>"text", "checkbox_value"=>true, "date_value"=>"2021-04-26"}], "days_valid"=>2, "external_id"=>"123", "is_phone_verification_required_to_view"=>true, "template_id"=>"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb", "source_files"=>[{"id"=>"12345", "etag"=>"1", "type"=>"file"}], "signature_color"=>"blue", "signers"=>[{"email"=>"example@gmail.com", "role"=>"signer", "is_in_person"=>true, "order"=>2, "embed_url_external_user_id"=>"1234", "redirect_url"=>"https://example.com", "declined_redirect_url"=>"https://declined-example.com", "login_required"=>true, "verification_phone_number"=>"6314578901", "password"=>"SecretPassword123", "signer_group_id"=>"cd4ff89-8fc1-42cf-8b29-1890dedd26d7"}], "parent_folder"=>{"id"=>"12345", "etag"=>"1", "type"=>"folder", "sequence_id"=>"3", "name"=>"Contracts"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: Created
{"is_document_preparation_needed":true,"redirect_url":"https://www.example.com","declined_redirect_url":"https://declined-redirect.com","are_text_signatures_enabled":true,"email_subject":"Sign Request from Acme","email_message":"Hello! Please sign the document below","are_reminders_enabled":true,"name":"name","prefill_tags":[{"document_tag_id":"1234","text_value":"text","checkbox_value":true,"date_value":"2021-04-26"}],"days_valid":2,"external_id":"123","is_phone_verification_required_to_view":true,"template_id":"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb","type":"sign-request","source_files":[{"id":"12345","etag":"1","type":"file"}],"signers":[{"email":"example@gmail.com","role":"signer","is_in_person":true,"order":2,"embed_url_external_user_id":"1234","redirect_url":"https://example.com","declined_redirect_url":"https://declined-example.com","login_required":true,"verification_phone_number":"6314578901","password":"SecretPassword123","signer_group_id":"cd4ff89-8fc1-42cf-8b29-1890dedd26d7","has_viewed_document":true,"signer_decision":{"type":"signed","finalized_at":"2021-04-26T08:12:13.982Z","additional_info":"Requesting changes before signing."},"inputs":[{"document_tag_id":"1234","text_value":"text","checkbox_value":true,"date_value":"2021-04-26","type":"text","content_type":"signature","page_index":4,"read_only":true}],"embed_url":"https://example.com","iframeable_embed_url":"https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4"}],"signature_color":"blue","id":"12345","prepare_url":"https://prepareurl.com","signing_log":{"id":"12345","etag":"1","type":"file","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"}},"status":"converting","sign_files":{"files":[{"id":"12345","etag":"1","type":"file","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"}}],"is_ready_for_download":true},"auto_expire_at":"2021-04-26T08:12:13.982Z","parent_folder":{"id":"12345","etag":"1","type":"folder","sequence_id":"3","name":"Contracts"}}