Send an e-sign document

POST

/esign/documents/{envelope_id}/send/

Send a draft e-sign document to its first signing step. Create-from-template does not auto-send; call this endpoint after the draft is ready. Before sending, RealAML validates that the document has a title, at least one file, at least one recipient, recipient email addresses, valid 2FA settings, PDF fields, and required signature fields. On success, the document status changes to sent and recipient notification/PDF preparation processing starts.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Responses

🟢202

application/json

Document send initiated.

Bodyapplication/json

🟠400BadRequest

🟠403Forbidden

🟠404NotFound

🔴500UnknownError

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

202 - Example 1

{
    "message": "string",
    "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
    "signing_url": "http://example.com",
    "status": "draft",
    "sent_at": "2019-08-24T14:15:22.123Z"
}

Create an e-sign iframe builder session

Resend an e-sign document