Skip to content
Last updated

Audit log

You can fetch the audit events recorded for a signing session:

GET /sign/sessions/{session_id}/audit

Records are returned oldest first. Use the list to show a simple activity flow, or persist it in your system if you need your own audit trail. See List audit records for a signing session.

Each record includes id, actor, actor_id, type, timestamp, and client. Other fields depend on the event type.

{
  "data": [
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88401",
      "actor": "integrator",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88001",
      "type": "session.created",
      "timestamp": "2026-09-24T11:16:15.897Z",
      "client": {
        "ip": "203.0.113.10",
        "user_agent": "PostmanRuntime/7.56.1"
      }
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88402",
      "actor": "integrator",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88001",
      "type": "participant.added",
      "timestamp": "2026-09-24T11:16:15.903Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "client": {
        "ip": "203.0.113.10",
        "user_agent": "PostmanRuntime/7.56.1"
      }
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88403",
      "actor": "integrator",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88001",
      "type": "participant.added",
      "timestamp": "2026-09-24T11:16:15.909Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88212",
      "client": {
        "ip": "203.0.113.10",
        "user_agent": "PostmanRuntime/7.56.1"
      }
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88404",
      "actor": "system",
      "actor_id": null,
      "type": "participant.invitation.created",
      "timestamp": "2026-09-24T11:16:15.904Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88311",
      "delivery": {
        "type": "manual",
        "target": null
      },
      "client": null
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88405",
      "actor": "system",
      "actor_id": null,
      "type": "participant.invitation.created",
      "timestamp": "2026-09-24T11:16:15.908Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88312",
      "delivery": {
        "type": "email",
        "target": "john.doe@example.org"
      },
      "client": null
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88406",
      "actor": "system",
      "actor_id": null,
      "type": "participant.invitation.created",
      "timestamp": "2026-09-24T11:16:15.909Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88212",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88321",
      "delivery": {
        "type": "manual",
        "target": null
      },
      "client": null
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88407",
      "actor": "system",
      "actor_id": null,
      "type": "participant.invitation.created",
      "timestamp": "2026-09-24T11:16:15.911Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88212",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88322",
      "delivery": {
        "type": "sms",
        "target": "+358401234567",
        "message": "Please sign by Friday."
      },
      "client": null
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88408",
      "actor": "integrator",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88001",
      "type": "session.started",
      "timestamp": "2026-09-24T11:16:19.647Z",
      "client": {
        "ip": "203.0.113.10",
        "user_agent": "PostmanRuntime/7.56.1"
      }
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88409",
      "actor": "system",
      "actor_id": null,
      "type": "participant.invitation.sent",
      "timestamp": "2026-09-24T11:16:19.974Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88312",
      "delivery": {
        "type": "email",
        "target": "john.doe@example.org"
      },
      "client": null
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f8840a",
      "actor": "participant",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "type": "participant.invitation.opened",
      "timestamp": "2026-09-24T11:16:57.698Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "invitation_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88312",
      "delivery": {
        "type": "email",
        "target": "john.doe@example.org"
      },
      "client": {
        "ip": "203.0.113.20",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/153.0.0.0 Safari/537.36"
      }
    },
    {
      "id": "0196ae5b-2e9d-729f-aba5-fa4db6f8840b",
      "actor": "participant",
      "actor_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "type": "participant.signing.identity-proven",
      "timestamp": "2026-09-24T11:17:05.000Z",
      "participant_id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
      "identity_proof": {
        "auth_type": "eid",
        "auth_channel": "fi_nordea",
        "identity": {
          "name": "John Doe",
          "date_of_birth": "1990-01-15"
        },
        "prover": {
          "name": "Telia Tunnistus",
          "proof_id": "bank-session-42"
        },
        "proven_at": "2026-09-24T11:17:05.000Z"
      },
      "client": {
        "ip": "203.0.113.20",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/153.0.0.0 Safari/537.36"
      }
    }
  ],
  "meta": {
    "status": {
      "code": 200,
      "text": "OK"
    }
  }
}

Event types

TypeMeaning
session.createdThe session is created.
session.startedThe session is started.
session.completedEvery participant has signed.
session.cancelledThe session is cancelled.
session.discardedThe session is discarded.
session.expiredThe session expired before it was completed.
participant.addedA participant is added.
participant.removedA participant is removed.
participant.declinedA participant declines to sign.
participant.reinstatedA declined participant is brought back to pending.
participant.excusedA participant is excused from signing.
participant.invitation.createdAn invitation is created.
participant.invitation.sentAn invitation is sent by email or SMS.
participant.invitation.openedAn invitation is opened.
participant.invitation.revokedAn invitation is revoked.
participant.signing.identity-provenThe participant's identity is proven.
participant.signing.completedA participant signs.