Skip to content

Get Events

Returns the full audit event history for a document in chronological order.

GET /v1/documents/:accessKey/events

Authentication

Authorization: Bearer <api-key> and X-Issuer-Id: <issuer-id> (numeric id from GET /v1/issuers)

Path parameters

ParameterDescription
accessKeyThe 49-digit access key of the document

Response

200 OK

json
{
  "ok": true,
  "events": [
    {
      "eventType": "CREATED",
      "fromStatus": null,
      "toStatus": "SIGNED",
      "detail": null,
      "createdAt": "2026-03-15T14:20:00.000Z"
    },
    {
      "eventType": "SENT",
      "fromStatus": "SIGNED",
      "toStatus": "RECEIVED",
      "detail": null,
      "createdAt": "2026-03-15T14:21:00.000Z"
    },
    {
      "eventType": "STATUS_CHANGED",
      "fromStatus": "RECEIVED",
      "toStatus": "AUTHORIZED",
      "detail": { "authorizationNumber": "1503202601179234567800110010010000000011234567810" },
      "createdAt": "2026-03-15T14:22:00.000Z"
    },
    {
      "eventType": "EMAIL_SENT",
      "fromStatus": null,
      "toStatus": null,
      "detail": null,
      "createdAt": "2026-03-15T14:22:05.000Z"
    }
  ]
}

Event types

EventMeaning
CREATEDDocument created and signed
SENTSubmitted to SRI
STATUS_CHANGEDSRI returned a new status
REBUILTDocument was rebuilt after rejection
ERRORAn error occurred during a lifecycle operation
EMAIL_SENTAuthorization email sent to buyer
EMAIL_FAILEDEmail send failed permanently
EMAIL_DELIVEREDMailgun confirmed delivery to the recipient's mail server
EMAIL_TEMP_FAILEDTemporary delivery failure — Mailgun will retry
EMAIL_COMPLAINEDRecipient marked the email as spam

Errors

CodeStatusWhen
UNAUTHORIZED401Missing or invalid API key
NOT_FOUND404Document not found

Comprobify API Documentation