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
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.00000000-0000-0000-0000-000000000000
with the envelope ID you received earlier.
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.generated
: