Fetch an e-sign document

GET

/esign/documents/{envelope_id}/

Fetch full e-sign document details, including files, recipients, field responses, final PDF URL, and completion certificate where available. Final PDF and certificate signed URLs are temporary. Use this endpoint after sending, webhooks, callbacks, or iframe events to inspect the latest document state.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Document details.

Bodyapplication/json

🟠403Forbidden

🟠404NotFound

🔴500UnknownError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/esign/documents//' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "template": "060ce75e-87d6-4677-b330-eaee58e54138",
    "agency": 0,
    "status": "draft",
    "user": 0,
    "name": "string",
    "completed_at": "2019-08-24T14:15:22.123Z",
    "email_subject": "string",
    "email_message": "string",
    "completion_message": "string",
    "resolved_email_subject": "string",
    "resolved_email_message": "string",
    "resolved_completion_message": "string",
    "related_check_id": "3709fbcd-594d-4a54-bc0b-041e6bbbea55",
    "related_custom_form_id": "c91a016b-8447-46eb-8b93-d31f6ffe4e76",
    "expires_at": "2019-08-24T14:15:22.123Z",
    "cc_emails": [
        "user@example.com"
    ],
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "sent_at": "2019-08-24T14:15:22.123Z",
    "documents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
            "file": "string",
            "name": "string",
            "order": 0,
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "signed_url_TEMP": "http://example.com"
        }
    ],
    "recipients": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
            "role_name": "string",
            "name": "string",
            "email": "user@example.com",
            "phone_number": "string",
            "require_2fa": true,
            "two_fa_method": "sms",
            "verification_type": "quick_id",
            "verification_status": "pending",
            "verification_result": "PASS",
            "verification_signature_key": "string",
            "redirect_url": "http://example.com",
            "has_signed": true,
            "signed_at": "2019-08-24T14:15:22.123Z",
            "notified_at": "2019-08-24T14:15:22.123Z",
            "created_at": "2019-08-24T14:15:22.123Z",
            "order": 1,
            "fields": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
                    "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
                    "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
                    "field_type": "primary_contact_name",
                    "page_number": 1,
                    "x": 0,
                    "y": 0,
                    "width": 0,
                    "height": 0,
                    "label": "string",
                    "required": true,
                    "metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "default_value": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "default_value_mode": "none",
                    "show_on_pdf": true,
                    "option_value": "string",
                    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                    "group_name": "string",
                    "min_selections": 0,
                    "max_selections": 0
                }
            ],
            "field_groups": [
                {
                    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                    "name": "string",
                    "field_type": "primary_contact_name",
                    "min_selections": 0,
                    "max_selections": 0,
                    "fields": [
                        {
                            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                            "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
                            "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
                            "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
                            "field_type": "primary_contact_name",
                            "page_number": 1,
                            "x": 0,
                            "y": 0,
                            "width": 0,
                            "height": 0,
                            "label": "string",
                            "required": true,
                            "metadata": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "default_value": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "default_value_mode": "none",
                            "show_on_pdf": true,
                            "option_value": "string",
                            "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                            "group_name": "string",
                            "min_selections": 0,
                            "max_selections": 0
                        }
                    ]
                }
            ],
            "status": "waiting",
            "is_self_sign": true
        }
    ],
    "fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
            "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
            "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
            "field_type": "primary_contact_name",
            "page_number": 1,
            "x": 0,
            "y": 0,
            "width": 0,
            "height": 0,
            "label": "string",
            "required": true,
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "default_value": {
                "property1": "string",
                "property2": "string"
            },
            "default_value_mode": "none",
            "show_on_pdf": true,
            "option_value": "string",
            "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
            "group_name": "string",
            "min_selections": 0,
            "max_selections": 0
        }
    ],
    "expiring_soon": true,
    "waiting_for_others": {
        "property1": "string",
        "property2": "string"
    },
    "action_required": [
        {
            "type": "voided",
            "message": "string",
            "recipients": [
                {
                    "recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",
                    "name": "string",
                    "email": "user@example.com",
                    "status": "waiting",
                    "decline_reason": "string",
                    "failed_auth_attempts": 0,
                    "order": 0
                }
            ]
        }
    ],
    "voided_reason": "string",
    "voided_at": "2019-08-24T14:15:22.123Z",
    "is_reinitiate_required": true,
    "self_sign": true,
    "expiry_alert_days": 1,
    "first_reminder_days": 1,
    "second_reminder_days": 1,
    "field_responses": [
        {
            "response_id": "696f09c4-2678-4263-8db2-0a7204e502c2",
            "recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",
            "recipient_name": "string",
            "field_id": "e68e30b1-d177-4632-b748-463bcd0eedc6",
            "field_type": "primary_contact_name",
            "value": "string",
            "signature_text": "string",
            "signature_font": "Helvetica",
            "signature_image_url_TEMP": "http://example.com"
        }
    ],
    "final_pdf_url_TEMP": "http://example.com",
    "completion_certificate": {
        "certificate_url_TEMP": "http://example.com",
        "certificate_hash": "string",
        "generated_at": "2019-08-24T14:15:22.123Z"
    }
}

Create an e-sign draft document

Update an e-sign draft document