Signing

Send access token for public document

Changed on

Send a one-time access token to a signer of a public document, so they can view it. The document must be pending signature, and recipient must belong to a signer of the document who has not signed yet. Only the email channel is supported. Public endpoint.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/public/documents/{documentId}/send-token

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/public/documents/{documentId}/send-token
  • Auth
    none required

Path parameters

documentIdstring required

The document ID.

Request body

channel'email' required

Where to send the token. Only email is supported.

recipientstring required

The signer's address on that channel — for email, the signer's email address.

Example request

{
  "channel": "email",
  "recipient": "signer@example.com"
}

Response

Token sent

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "document": {
      "resource": "document",
      "id": "a1b2c3d4e5f6a7b8c9d0",
      "name": "Contract.pdf",
      "page_count": 3,
      "created_by": "Jane Doe"
    },
    "channel": "email",
    "recipient": "signer@example.com"
  }
}

Changes

  • c4913641cd48Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      request body became required

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status