docs

Get self-distributable signing links per recipient

Returns one unique signing link per recipient for a document, so you can distribute the links yourself over any channel (your own service, a manual share, etc.) instead of relying on Formify's email/SMS/WhatsApp invitation.

This is the companion to the per-signee disableInvitationMessage flag on POST /docs (and the draft flow): set that flag to suppress Formify's own invitation, then call this endpoint to fetch the link to hand out.

Verification on open — important

Because these links are shared outside Formify's own channels, they could leak. Every link returned here therefore requires verification: before the document can be opened and signed, the recipient must verify with a one-time code (requiresVerification is always true).

  • The code is always sent to the contact method Formify has on file for that recipient (the email/phone you provided) — never to a value the opener types in. Whoever receives a forwarded link cannot verify it with their own address.
  • Verification is enforced regardless of the document's other verification settings.
  • No extra API calls are needed to drive this: the verification step happens automatically in the browser when the recipient opens the link. You only need to deliver the signingUrl.

Calling this endpoint generates and persists a unique signing key for each recipient on first use (subsequent calls return the same links), which is why it requires the write scope.

One link per recipient signing share

A signee given both an email and a phone number is split into two signing shares, so they are returned as two separate links — the same signeeId appears twice, each entry tagged with the verificationChannel (email, sms, or whatsapp) the code is sent to. Choose whichever link you want to distribute.

Recipients without a contact method

A recipient with no email or phone on file cannot be verified (there is nowhere to send the code), so no link is produced for them and they are omitted from the response entirely. This cannot be repaired on a sent document: PATCH /docs/{documentId}/signature-field can change an existing contact method but never add one. If a link is needed for such a recipient, revoke the document and send a new one with an email or phone number for them. Signees created through this API always have at least one contact method, so this mainly affects documents created elsewhere.

get/docs/{documentId}/recipient-links

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/docs/{documentId}/recipient-links
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

documentIdstring uuid required

Unique identifier of the document.

Query parameters

errorLanguage'en' | 'sv' | 'es'

Language for any error message.

Response

Per-recipient signing links.

documentIdstring uuid

The document these links belong to.

exampleunknown

Changes

No recorded changes to this operation across all 1 revision of this API.