Get Recipient Links
get_recipient_linksGet unique, self-distributable signing links for a document — one per recipient — so the sender can hand out the links over any channel instead of relying on Formify's email/SMS/WhatsApp invitation. Use this for signees created with disableInvitationMessage: true (Formify did not invite them), or whenever the user wants to distribute a signing link themselves. SECURITY: every returned link is verification-locked. Opening one requires a one-time code that Formify sends to the recipient's contact method on file (the email/phone provided), never to a value the opener types in — so a leaked or forwarded link cannot be opened by anyone else. The lock is enforced automatically in the browser when the recipient opens the link; no extra calls are needed. Simply deliver the signingUrl. The response contains one entry per recipient signing share: signeeId, fullName, emailAddress/phoneNumber (contact on file), verificationChannel ('email' | 'sms' | 'whatsapp'), signingUrl, and requiresVerification (always true). A recipient given BOTH an email and a phone is returned as TWO entries (same signeeId, one per verificationChannel) — present both and let the user choose which to distribute. A recipient with no contact method on file cannot be verified, so they are omitted from the response entirely; add a contact method via update_signee first if a link is expected but missing. Calling this generates and persists the links on first use (idempotent on later calls). Only works on a sent document, not a draft.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Unique identifier of the document |