Integration manual
eSignature
Create signing links, record consent and retain a signed copy and evidence.
Choose the integration
API signing has a monthly platform fee plus document volume, selected in steps of 100. The workspace has a monthly platform fee plus sender licences with included documents. Personal access includes 3 documents a month without business API access. Trial and sandbox allowances are bounded. Completion consumes one unit; retries and reminders are not additional completions.
Create a signing link
Upload a PDF up to 5 pages and 10 MB with a title and one recipient email. Add a fields multipart value containing a JSON array of {id, type, page, x, y, width, height}; type is signature, name or date, page is 1-based and coordinates are fractions of the displayed page measured from its top-left. Include at least one signature field when providing fields. The workspace provides a visual field editor. Retain the returned envelope id. Share the returned private signing link through your existing communication service, or add the multipart delivery field with value email to request an invitation. Check delivery and deliveryMessage in the response; a failed email does not mean the signing request failed.
curl https://eu.mimeprotect.com/api/security/envelopes \
-H "Authorization: Bearer $MIMEPROTECT_API_KEY" \
-H "Idempotency-Key: $SIGNING_REQUEST_ID" \
-F "document=@agreement.pdf" \
-F "title=Investment agreement" \
-F "recipient=signer@example.com" \
-F "product=esign-platform"Recover safely after a connection failure
Send an Idempotency-Key header containing a random UUID for each new signing request. Keep the key alongside your request until you receive a response. Retry the same PDF bytes, title, recipient, product, fields and delivery choice with that key for up to 24 hours. You receive the same agreement and private link; changed details return 409. Keys are scoped to your organisation, region, environment and sender. API keys and workload identities share the service scope so credential rotation does not break recovery. Retries do not send another email; delivery=not_repeated means use the returned link or check the agreement status. After 24 hours, the same key can create a new request. Other creation endpoints do not support this header yet.
Review and consent
The recipient reviews the PDF in the signing page, enters their name and explicitly agrees to sign electronically. The link expires after 7 days. This signing method establishes possession of the link and recorded consent; the stated recipient email is not independent identity verification.
Track completion and keep your records
Read GET /api/security/envelopes/{id} to track completion. When status is completed, download completedDocumentUrl and evidenceUrl using your API key. After completion, sender and signer can download the final PDF; the signer’s private link also provides the signing evidence. The record includes document digest, name, intent, timestamp and connection metadata. The completed PDF carries a MimeProtect proof. This is a service evidence seal, not a qualified personal certificate. Default retention is 30 days.
Email delivery and stronger assurance
Your integration can deliver the returned link itself, or request a configured invitation email with delivery=email. Sandbox only returns a test link and never sends invitations. Contact us about recipient authentication, multi-signer orchestration and regulated signing requirements before relying on those workflows.
Ready to connect it?
Open your regional workspace, create a sandbox key and test the complete flow with synthetic data. Keep the returned identifiers and inspect every result before moving to production.
Open the sandbox →Discuss your requirements →