In this quickstart, we’ll walk you through sending a simple privacy policy document to Jane Doe (at jane@example.com) for her signature.
To get started, sign up for a free test API key. This test API key allows you to create test envelopes without any legal effect and at no cost.
An envelope is a container that holds the documents you need to send for signing. Each envelope can include one or more documents and can be sent to one or multiple signers.
In this quickstart, we will create an envelope with one document, one recipient, and a single signing place. We’ll use curl
and the command line for this example.
Replace key_test_xxxxxxxx
in the code snippet below with your test API key (which starts with key_test_
) and paste it into your command line.
Explain the request
This request creates an envelope titled Dummy Consent
with a message "Please review..."
that will be included in the emails sent to the recipient.
The envelope has one recipient, identified by the key visitor
. This recipient is a signer named Jane Doe
, with the email jane@example.com
.
The envelope contains one document, a PDF hosted at https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/privacy-placeholder.pdf
.
The document includes a place for the recipient visitor
to sign. The placeholder is of type signature
and links to the placeholder [[signer_signs_here]]
inside the PDF document.
Once you’ve sent the request, you should see a response like this (formatted for readability):
Although test API keys don’t send real emails, you can view the email that would be sent in the Dashboard.
In the envelope details, scroll down to the Emails section and click on the email sent to Jane Doe.
You’ll be able to preview the email and see how it would appear if it were sent to the recipient. In test mode, however, emails are not actually sent to recipients.
Click on the blue button in the email preview to go to the signing ceremony as Jane.
Now, you’ll step into Jane Doe’s shoes as the signer. Go through the signing ceremony and sign the document as Jane would.
Once Jane has signed the document, let’s check the status of the envelope and the recipients to make sure everything is moving along smoothly.
To do this, we’ll use the following curl command to retrieve the envelope’s status. Replace the API key with your test key and 00000000-0000-0000-0000-000000000000
with the envelope ID you received earlier.
The response will look something like this (we redacted some of the parts that didn’t change):
Here’s what to check:
recipients
array, the status should be marked as completed
. This confirms Jane signed the document.completed
, meaning the envelope process is finished as all the recipients signed the envelope.processing
status, which indicates SignatureAPI is still generating the final signed document. This can take up to two minutes. You can repeat the GET request to check when it’s ready.Once completed, the deliverable status will change to generated
:
The deliverable, is also sent to the recipients—in this case, Jane. To view the email Jane received with the completed document, follow these steps:
You’ll also notice that two additional notifications were sent to the account owner (Richard Roe). These notify you that Jane signed the envelope and that the envelope process is fully completed.
From the envelope page, you can download the signed document (the deliverable) by clicking the download button.
You’ve just scratched the surface of what SignatureAPI can do. Here are a few powerful features you can explore:
In this quickstart, we’ll walk you through sending a simple privacy policy document to Jane Doe (at jane@example.com) for her signature.
To get started, sign up for a free test API key. This test API key allows you to create test envelopes without any legal effect and at no cost.
An envelope is a container that holds the documents you need to send for signing. Each envelope can include one or more documents and can be sent to one or multiple signers.
In this quickstart, we will create an envelope with one document, one recipient, and a single signing place. We’ll use curl
and the command line for this example.
Replace key_test_xxxxxxxx
in the code snippet below with your test API key (which starts with key_test_
) and paste it into your command line.
Explain the request
This request creates an envelope titled Dummy Consent
with a message "Please review..."
that will be included in the emails sent to the recipient.
The envelope has one recipient, identified by the key visitor
. This recipient is a signer named Jane Doe
, with the email jane@example.com
.
The envelope contains one document, a PDF hosted at https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/privacy-placeholder.pdf
.
The document includes a place for the recipient visitor
to sign. The placeholder is of type signature
and links to the placeholder [[signer_signs_here]]
inside the PDF document.
Once you’ve sent the request, you should see a response like this (formatted for readability):
Although test API keys don’t send real emails, you can view the email that would be sent in the Dashboard.
In the envelope details, scroll down to the Emails section and click on the email sent to Jane Doe.
You’ll be able to preview the email and see how it would appear if it were sent to the recipient. In test mode, however, emails are not actually sent to recipients.
Click on the blue button in the email preview to go to the signing ceremony as Jane.
Now, you’ll step into Jane Doe’s shoes as the signer. Go through the signing ceremony and sign the document as Jane would.
Once Jane has signed the document, let’s check the status of the envelope and the recipients to make sure everything is moving along smoothly.
To do this, we’ll use the following curl command to retrieve the envelope’s status. Replace the API key with your test key and 00000000-0000-0000-0000-000000000000
with the envelope ID you received earlier.
The response will look something like this (we redacted some of the parts that didn’t change):
Here’s what to check:
recipients
array, the status should be marked as completed
. This confirms Jane signed the document.completed
, meaning the envelope process is finished as all the recipients signed the envelope.processing
status, which indicates SignatureAPI is still generating the final signed document. This can take up to two minutes. You can repeat the GET request to check when it’s ready.Once completed, the deliverable status will change to generated
:
The deliverable, is also sent to the recipients—in this case, Jane. To view the email Jane received with the completed document, follow these steps:
You’ll also notice that two additional notifications were sent to the account owner (Richard Roe). These notify you that Jane signed the envelope and that the envelope process is fully completed.
From the envelope page, you can download the signed document (the deliverable) by clicking the download button.
You’ve just scratched the surface of what SignatureAPI can do. Here are a few powerful features you can explore: