ATatlaswork
signer

Get the envelope as seen by the authenticated signer

Changed on

Party-scoped read: returns the envelope summary, the signer's own participant record and fields, position/progress slots for every participant (no names or emails), and a short-lived documentUrl. For a participant whose turn has not arrived, fields is empty and documentUrl is null. Records a throttled participant.viewed event.

get/api/signer/envelope

Request

  • Base URL
    https://api.atlaswork.ai
  • URL
    https://api.atlaswork.ai/api/signer/envelope
  • Auth
    HTTP bearer

Response

The signer-scoped envelope view

isMyTurnboolean required
senderNamestring nullable required
senderEmailstring nullable required
documentUrlstring uri nullable required

Changes

  • d3b4f91b9bb2Revision changes
    • warning

      added the new skipped enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status