Documents

Get document audit trail

Returns the ordered chain-of-custody events (sent, viewed, signed, declined, etc.) for the document

get/v1/documents/{id}/audit

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/documents/{id}/audit
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Document UUID

Response

idstring uuid required
documentIdstring uuid required
documentRecipientIdstring uuid nullable
typestring required

Event type

actorNamestring nullable
actorEmailstring nullable
apiKeyIdstring uuid nullable

API key that performed the action (when applicable)

apiKeyNamestring nullable

Human-readable name of the API key used (when applicable)

ipAddressstring nullable
userAgentstring nullable
metadataobject nullable
createdAtstring date-time required

Example response

[
  {
    "type": "signed"
  }
]

Changes

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