Signature Request

Signature Request endpoints are how the HelloSign API facilitates signing. They're used to send and interact with new signature requests, as well as manage, and gain insight into requests that have already be sent. Signature Requests offer a broad range of features such as group signing, qualified electronic signature, sms delivery, and many more.

The Signature Request object returned by these endpoints can be used to reference request-specific data including the names and email addresses of signers, custom fields, metadata, response data, and timestamps for when the request was created and completed.

Tips:

  • The /signature_request/list endpoint returns a list of Signature Request objects that your account can access. Using query string parameters to apply search logic is a great way to find specific documents or requests.
  • Need to update a signer name or email for an in-flight Signature Request? Pass the updated information and signature_request_id to /signature_request/update/{signature_request_id}.

When Signature Requests are sent without any signer fields on the document, HelloSign automatically appends a signature page on the end of the file. Placing signer fields on the document prevents this behavior. Learn more about placing fields on documents in this Help Center article: How to Place Fields Directly on Documents.

warning

Signature Requests that use an appended signature page cannot be updated. The /signature_request/update endpoint only works on documents that contain signer fields.

Signature Request Endpoints

SummaryEndpointDescription
Get Signature Request/template/{template_id}Returns the Template specified by the template_id parameter.
List Signature Requests/signature_request/listReturns a list of SignatureRequests that you can access.
Download Files^^/files/{signature_request_id}Obtain a copy of the current documents specified by the signature_request_id parameter.
Send Signature Request/signature_request/sendCreates and sends a new SignatureRequest with the submitted documents.
Send with Template/signature_request/send_with_templateCreates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.
Bulk Send with Template/signature_request/bulk_send_with_templateCreates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter.
Send Request Reminder^^/remind/{signature_request_id}Sends an email to the signer reminding them to sign the signature request.
Release On-Hold Signature Request^^/release_hold/{signature_request_id}Releases a held SignatureRequest that was claimed and prepared from an UnclaimedDraft.
Update Signature Request^^/update/{signature_request_id}Updates the email address and/or the name for a given signer on a signature request.
Cancel Incomplete Signature Request^^/cancel/{signature_request_id}Cancels an incomplete signature request. This action is not reversible.
Remove Signature Request Access^^/remove/{signature_request_id}Removes your access to a completed signature request. This action is not reversible.
Create Embedded Signature Request/signature_request/create_embeddedCreates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame.
Create Embedded Signature Request with Template^^/create_embedded_with_templateCreates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
Embedded Bulk Send with Template^^/bulk_create_embedded_with_templateCreates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter to be signed in an embedded iFrame.