links

Retrieve public link details

Retrieves a public link's full configuration, including its signature slots and the URL to share.

get/links/{linkId}

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/links/{linkId}
  • 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

linkIdstring uuid required

The unique identifier of the public link.

Query parameters

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

Language for the error message

Response

Public link details retrieved successfully

linkIdstring uuid

Unique identifier of the public link

namestring

Name of the link

createdAtstring date-time

When the link was created

updatedAtstring date-time nullable

When the link was last edited

userIdstring uuid

User ID of the link owner

sharingSetting'shared' | 'private'

Who on the account may administer the link

status'active' | 'disabled' | 'processing'
  • active: the link is live and can be opened and signed.
  • disabled: the link has been switched off and no longer accepts new signers. Documents already produced by it are unaffected. There is no way to switch it back on.
  • processing: the AI assistant is still reading the document. linkUrl is null and the link cannot be edited until this finishes.

Note this is a different set of values from a document's status — a link is a source of documents rather than a signature request, so it has no signing progress of its own.

linkUrlstring nullable

The link to share. null while status is processing, because the document is not servable yet.

Uses the account's custom domain when one is configured. Formify never sends this to anyone — distributing it is up to you.

fileIdstring uuid nullable

The uploaded file the link was built from, when it is still available

language'en' | 'sv' | 'es'

Language of the signing experience

Example response

{
  "aiAssistant": {
    "enabled": true,
    "language": "en"
  },
  "signeeDetails": [
    {
      "fullName": "Buyer",
      "signatureType": "digital_ink",
      "signaturePlacement": "existing",
      "signatureBox": {
        "page": 0,
        "x": 72,
        "y": 560,
        "scale": 1
      },
      "requireNameClarification": true
    }
  ]
}

Changes

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