Documents

Get a signing link

post/documents/{id}/recipients/{recipient_id}/signing-link

Returns a recipient's signing link, for a document that is still out for signature. With sequential signing, a signer's link is available only on their turn; before that this returns signing_link_unavailable. Anyone holding the link can sign, so never log it or put it in a public page.

Needs a key with documents:send. Send no body, or an empty {}.

Path parameters

idUUIDRequired
The document ID.
recipient_idUUIDRequired
The recipient ID, from the document's recipients.

Example request

curl -X POST "https://www.inkly.so/api/v1/documents/3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34/recipients/5b7e9d13-2c84-4f06-b1a9-6d40e8c2f715/signing-link" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "signing_url": "https://www.inkly.so/documents/3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34/sign/example-signing-token"
}

Response fields

signing_urlURLRequired
Treat it like a password: anyone holding it can sign.

Errors specific to this endpoint

unknown_field400This field is not supported.
document_not_found404Document not found.
signing_link_unavailable409This signing link is not available.

Every endpoint can also return the common errors.