The Create Envelope, Send Envelope, and Get Envelope endpoints all return an Envelope object describing the envelope, its documents, and their recipients.
Unique identifier for the envelope.
The current status of the envelope.
The documents included in this envelope.
The date and time the envelope was created.
The date and time the envelope was completed, if applicable.
The date and time the envelope expired, if applicable.
Custom key-value data you set on the envelope at creation time.
1{2 "id": "69c0fa44f83ca6a7015f1c8c",3 "status": "completed",4 "documents": [5 {6 "sourceDocumentId": "69bd87a32da418e6c4d2azze",7 "signedDocumentId": "69bd87a32da418e6c4d2b100",8 "auditLogDocumentId": "69bd87a32da418e6c4d2b101",9 "recipients": [10 {11 "email": "[email protected]",12 "status": "signed",13 "signedAt": "2024-02-14T09:12:03.000Z",14 "viewedAt": "2024-02-14T09:10:41.000Z",15 "fields": [16 { "name": "full_name", "type": "text", "value": "Anna Smith" },17 { "name": "signature", "type": "signature", "value": "..." }18 ]19 }20 ],21 "status": "completed",22 "completedAt": "2024-02-14T09:12:03.000Z"23 }24 ],25 "createdAt": "2024-02-13T15:56:12.607Z",26 "completedAt": "2024-02-14T09:12:03.000Z",27 "metadata": {28 "customerId": "cus_123",29 "department": "sales"30 }31}The Create Envelope endpoint creates a new envelope for one or more previously generated PDF documents.
Each document must include a sourceDocumentId, which is the document ID returned by the Generate PDF endpoint. Each document must also include one or more recipients.
This endpoint creates the envelope in the created status. See Envelope Statuses for more details about the envelope lifecycle. After calling this endpoint, you should use the Send Envelope endpoint to email each recipient a link to the signing UI.
See the Getting Started guide for a complete example.
Array of documents to include in the envelope.
Name of the user or system creating the envelope.
Sets custom data.
1curl \2 -H "Content-Type: application/json" \3 -H "Authorization: Bearer YOUR_API_KEY" \4 --request POST \5 --data '{6 "requesterName":"John Doe",7 "documents":[8 {9 "sourceDocumentId":"6642381c5c61",10 "name":"Employment Agreement",11 "recipients":[12 {13 "email":"[email protected]",14 "name":"Anna Smith",15 "role":"signer",16 "reminderIntervalDays":3,17 "reminderAttempts":218 }19 ]20 }21 ]22 }' \23 https://api.pdfgate.com/envelope1{2 "id": "69c0fa44f83ca6a7015f1c8c",3 "status": "created",4 "documents": [5 {6 "sourceDocumentId": "69bd87a32da418e6c4d2azze",7 "recipients": [8 {9 "email": "[email protected]",10 "status": "pending",11 "fields": []12 }13 ],14 "status": "pending"15 }16 ],17 "createdAt": "2024-02-13T15:56:12.607Z",18 "metadata": {19 "customerId": "cus_123",20 "department": "sales"21 }22}The Send Envelope endpoint sends an email to each recipient in the envelope with a secure link to access the signing UI and sign the document. The link remains valid for 30 days, after which it expires and can no longer be used.
To ensure secure access, recipients must complete OTP (one-time password) verification before accessing the signing experience.
The envelope ID.
1curl \2 -H "Authorization: Bearer YOUR_API_KEY" \3 --request POST \4 https://api.pdfgate.com/envelope/{envelopeId}/send1{2 "id": "69c0fa44f83ca6a7015f1c8c",3 "status": "in_progress",4 "documents": [5 {6 "sourceDocumentId": "69bd87a32da418e6c4d2azze",7 "recipients": [8 {9 "email": "[email protected]",10 "status": "pending",11 "fields": [],12 "signingLink": "https://api.pdfgate.com/sign/eyJhbGciOi..."13 }14 ],15 "status": "pending"16 }17 ],18 "createdAt": "2024-02-13T15:56:12.607Z",19 "metadata": {20 "customerId": "cus_123",21 "department": "sales"22 }23}The Get Envelope endpoint retrieves the current state of an envelope by its ID.
You can use this endpoint to track the envelope status, inspect document-level progress, and view recipient statuses.
The envelope ID.
1curl \2 -H "Authorization: Bearer YOUR_API_KEY" \3 --request GET \4 https://api.pdfgate.com/envelope/{envelopeId}1{2 "id": "69c0fa44f83ca6a7015f1c8c",3 "status": "completed",4 "documents": [5 {6 "sourceDocumentId": "69bd87a32da418e6c4d2azze",7 "signedDocumentId": "69bd87a32da418e6c4d2b100",8 "auditLogDocumentId": "69bd87a32da418e6c4d2b101",9 "recipients": [10 {11 "email": "[email protected]",12 "status": "signed",13 "signedAt": "2024-02-14T09:12:03.000Z",14 "viewedAt": "2024-02-14T09:10:41.000Z",15 "fields": []16 }17 ],18 "status": "completed",19 "completedAt": "2024-02-14T09:12:03.000Z"20 }21 ],22 "createdAt": "2024-02-13T15:56:12.607Z",23 "completedAt": "2024-02-14T09:12:03.000Z",24 "metadata": {25 "customerId": "cus_123",26 "department": "sales"27 }28}An envelope moves through different statuses during the signing process. The status shows whether the envelope has been created, sent for signing, completed, or expired.
Lifecycle
Envelopes created through the dashboard start with the draft status while they are being configured. Once sent, the status moves to created and then immediately to in_progress.
Envelopes created through the API start directly with the created status.
After the envelope is sent using POST /envelope/:id/send, the status becomes in_progress.
When all required documents and signatures are completed, the envelope becomes completed.
If an envelope stays in created or in_progress for one month without being completed, it becomes expired.
Once an envelope expires, unsigned documents inside it can no longer be signed through the original envelope. To collect signatures for documents from an expired envelope, create a new envelope and resend the signature requests.
You are not charged for signatures that were not completed before the envelope expired.
Reminders
Reminder emails are sent only while the envelope is active. Reminders stop when:
The envelope is being configured in the dashboard. Recipients and fields have not been finalized yet.
The envelope has been created but has not been sent for signing yet.
The envelope has been sent to the recipients and is waiting for one or more required signatures.
All required recipients have signed the assigned documents in the envelope.
The envelope was not completed within one month. Unsigned documents inside the envelope can no longer be signed through this envelope. To collect the remaining signatures, create a new envelope and resend the signature requests. Incomplete signatures are not charged.