Create an e-sign draft document
POST
/esign/documents/
template_id; the API creates an empty draft and the iframe builder is used to upload files, manage recipients, place PDF fields, and send. To create from a template, provide template_id; RealAML copies template files, recipient roles, and PDF fields into a new draft. Optional recipients entries are recipient overrides and must map to template roles with template_role_id. Creation never sends automatically; call POST /documents/{envelope_id}/send/ or send from the iframe builder when the draft is ready.Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/esign/documents/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Client agreement"
}'Response Response Example
201 - 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
}