SMS Tools Walkthrough
There are a couple of options that we provide through our SMS Tools add-on that can help improve your workflow by enabling SMS features. Take a look at the different features we offer to see if this add-on can increase the capability for your workflow.
SMS Tools Add-on
The SMS Tools add-on is an additional charge that provides two SMS-based features that can be included in your workflow: SMS authentication and SMS delivery. This add-on can be used with a Standard API plan or higher. For more details on our API plans, please see our plans and pricing page. For any questions regarding the SMS Tools add-on option or billing, please contact our Sales team with this form.SMS Authentication
The SMS authentication feature provides the option to include a unique SMS authentication code that is sent to the signer once the signature request is submitted. In order for the signer to open and complete their portion of the document, they’ll need to provide the unique code sent via SMS. This adds an additional layer of security when having your signers complete their signature requests.
SMS Delivery
The SMS delivery feature provides a link to sign the signature request via both email and SMS. Once the signature request is sent to the signers, each signer will receive both an email notification and an SMS message with a link to complete their portion of the document.
Requirements
attention
SMS Authentication | SMS Delivery |
---|---|
|
|
Updating Admin Console Settings
Admin Console | Images |
---|---|
Access Admin Console:
| |
Steps to update signer authentication:
| |
Steps to update signature request delivery methods:
|
Using SMS Authentication and SMS Delivery
warning
- SMS authentication and SMS delivery cannot be tested in
test_mode
. - Message and data rates for SMS messaging may apply.
- SMS Features may not be available in all countries. If receiving an error, please send a request to our support team using this form.
Both features available for the following API endpoints:
- Send Signature Request
- Send with Template
- Bulk Send with Template
- Create Embedded Signature Request
- Create Embedded Signature Request with Template
- Embedded Bulk Send with Template
Process
Steps | Images |
---|---|
1. For SMS authentication, once you send your request your signers will receive an email with a link to sign the document. | |
2. The signer will then open that link and they will be prompted to verify their identity. | |
3. At this point, they can select the “Send code” button to receive a 6-digit code via text message to the phone number associated with that signer (redacted in the prompt). They can then enter the code and continue with the signing process. Additionally, they can request the code to be sent again if needed. | |
4. Once the correct code has been entered, the document will appear ready for the signer to complete their portion of the document. |
Steps | Images |
---|---|
1. For SMS delivery, when the request is sent, both an email and a text message with a link to sign the document will be sent to the signers. | |
2. They can then complete their portion of the document by clicking on either link. Once signed, they will receive a text message stating they have completed it and to check their email for the completed document. | |
3. Additionally, if enabled on your account, they will see the 3 and 7 day signature request reminders via text message as well. |
Examples:
attention
SMS Authentication
{
"title": "NDA with Acme Co.",
"subject": "The NDA we talked about",
"message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
"signers": [
{
"role": "Client",
"email_address": "jack@example.com",
"name": "Jack",
"order": 0,
// Add E.164 formatted phone number
"sms_phone_number": "12345678901",
// Add the phone number type as authentication
"sms_phone_number_type": "authentication"
}
],
"file_urls": [
"https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"
],
"signing_options": {
"draw": true,
"type": true,
"upload": true,
"phone": true,
"default_type": "draw"
},
// Test mode must be false
"test_mode": false
}
curl -X POST 'https://api.hellosign.com/v3/signature_request/send_with_template' \
-u 'YOUR_API_KEY:' \
-F 'client_id=YOUR_CLIENT_ID' \
-F 'template_ids[]=61a832ff0d8423f91d503e76bfbcc750f7417c78' \
-F 'title=NDA with Acme Co.'
-F 'subject=The NDA we talked about' \
-F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \
-F 'signers[0][role]=Client' \
-F 'signers[0][name]=Jack' \
-F 'signers[0][email_address]=jack@example.com' \
-F 'signers[0][sms_phone_number]=12223333333' \
-F 'signers[0][sms_phone_number_type]=authentication' \
-F 'signing_options[draw]=1' \
-F 'signing_options[type]=1' \
-F 'signing_options[upload]=1' \
-F 'signing_options[phone]=1' \
-F 'signing_options[default_type]=draw' \
-F 'test_mode=0'
SMS Delivery
{
"title": "NDA with Acme Co.",
"subject": "The NDA we talked about",
"message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
"signers": [
{
"email_address": "jack@example.com",
"name": "Jack",
"order": 0,
// Add E.164 formatted phone number
"sms_phone_number": "12345678901",
// Add the phone number type as delivery
"sms_phone_number_type": "delivery"
}
],
"file_urls": [
"https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"
],
"signing_options": {
"draw": true,
"type": true,
"upload": true,
"phone": true,
"default_type": "draw"
},
// Test mode must be false
"test_mode": false
}
curl -X POST 'https://api.hellosign.com/v3/signature_request/send_with_template' \
-u 'YOUR_API_KEY:' \
-F 'client_id=YOUR_CLIENT_ID' \
-F 'template_ids[]=61a832ff0d8423f91d503e76bfbcc750f7417c78' \
-F 'title=NDA with Acme Co.'
-F 'subject=The NDA we talked about' \
-F 'message=Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.' \
-F 'signers[0][role]=Client' \
-F 'signers[0][name]=Jack' \
-F 'signers[0][email_address]=jack@example.com' \
-F 'signers[0][sms_phone_number]=12345678901' \
-F 'signers[0][sms_phone_number_type]=delivery' \
-F 'signing_options[draw]=1' \
-F 'signing_options[type]=1' \
-F 'signing_options[upload]=1' \
-F 'signing_options[phone]=1' \
-F 'signing_options[default_type]=draw' \
-F 'test_mode=0'