theme
HelloSign
FREE
By hellosign
Updated a year ago

HelloSign API Documentation

Signatures. Made simple.
Getting documents signed has never been simpler. We've removed paper entirely from the process and built tools to facilitate document signing, tracking and management. Notifications keep you apprised of the signer's activity and our audit trail logs it. Once completed, signed documents are securely stored and accessible from the cloud so you can always get to your important documents.

Sharing is just as easy. With HelloSign you can share templates and signed documents with your team, other internal departments and even outside counsel, so everyone is on the same paperless page.

Learn more about this API
Account
POSTCreate account
GETGet account
POSTPost account
UnclaimedDraft
POSTCreate draft
ReusableForm
GETGet Reusable Form
POSTGive access to Reusable Form
GETList Reusable Forms
POSTRemove access to Reusable Form
Team
POSTAdd member
POSTCreate team
POSTDelete team
GETGet team
POSTPost team
POSTRemove member
SignatureRequest
GETGet signature request
GETList signature requests
POSTSend signature request
POSTSend signature request with Reusable Form
POSTCreate draft

Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. If the type is "senddocument" then only the file parameter is required. If the type is "requestsignature", then the identities of the signers and optionally the location of signing elements on the page are also required.

Authorization:

description

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
AuthorizationBASIC
REQUIREDdescription
Required Parameters
file[]STRING
REQUIREDThe file(s) to send for signature.
typeSTRING
REQUIREDThe type of unclaimed draft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request. If the type is "request_signature" then signers name and email_address are not optional.
Optional Parameters
test_modeSTRING
OPTIONALWhether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0.
subjectSTRING
OPTIONALThe subject in the email that will be sent to the signers.
signers[%i%][name]STRING
OPTIONALThe name of the signer. %i% is an integer that should be unique for each signer.
form_fields_per_documentSTRING
OPTIONALThe form fields that should appear on the document, expressed as a serialized JSON data structure which is a list of lists of the form fields. One list is required for each file[]. In the case of a file with no form fields, and empty list must be specified. Each field must identify which signer is supposed to fill out the form field, which type of form field it is, its location and size, and if it is required. The signer is identified by the offset (%i%) in the "signers" parameter. ReusableForm objects contain fields of the this type in "form_fields". If this parameter is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
cc_email_addresses[]STRING
OPTIONALThe email addresses that should be CCed.
requester_email_addressSTRING
OPTIONALThe email address of the initiator of the SignatureRequest.
messageSTRING
OPTIONALThe custom message in the email that will be sent to the signers.
signers[%i%][email_address]STRING
OPTIONALThe email address of the signer. %i% is an integer that should be unique for each signer.
signers[%i%][order]STRING
OPTIONALThe order the signer is required to sign in. %i% is an integer that should be unique for each signer.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication