{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Audit log"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"audit-log","__idx":0},"children":["Audit log"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can fetch the audit events recorded for a signing session:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /sign/sessions/{session_id}/audit\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/embed-api/openapi/signing/listsigningsessionauditrecords"},"children":["List audit records for a signing session"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each record includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["actor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["actor_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client"]},". Other fields depend on the event type."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88401\",\n      \"actor\": \"integrator\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88001\",\n      \"type\": \"session.created\",\n      \"timestamp\": \"2026-09-24T11:16:15.897Z\",\n      \"client\": {\n        \"ip\": \"203.0.113.10\",\n        \"user_agent\": \"PostmanRuntime/7.56.1\"\n      }\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88402\",\n      \"actor\": \"integrator\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88001\",\n      \"type\": \"participant.added\",\n      \"timestamp\": \"2026-09-24T11:16:15.903Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"client\": {\n        \"ip\": \"203.0.113.10\",\n        \"user_agent\": \"PostmanRuntime/7.56.1\"\n      }\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88403\",\n      \"actor\": \"integrator\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88001\",\n      \"type\": \"participant.added\",\n      \"timestamp\": \"2026-09-24T11:16:15.909Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88212\",\n      \"client\": {\n        \"ip\": \"203.0.113.10\",\n        \"user_agent\": \"PostmanRuntime/7.56.1\"\n      }\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88404\",\n      \"actor\": \"system\",\n      \"actor_id\": null,\n      \"type\": \"participant.invitation.created\",\n      \"timestamp\": \"2026-09-24T11:16:15.904Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88311\",\n      \"delivery\": {\n        \"type\": \"manual\",\n        \"target\": null\n      },\n      \"client\": null\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88405\",\n      \"actor\": \"system\",\n      \"actor_id\": null,\n      \"type\": \"participant.invitation.created\",\n      \"timestamp\": \"2026-09-24T11:16:15.908Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88312\",\n      \"delivery\": {\n        \"type\": \"email\",\n        \"target\": \"john.doe@example.org\"\n      },\n      \"client\": null\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88406\",\n      \"actor\": \"system\",\n      \"actor_id\": null,\n      \"type\": \"participant.invitation.created\",\n      \"timestamp\": \"2026-09-24T11:16:15.909Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88212\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88321\",\n      \"delivery\": {\n        \"type\": \"manual\",\n        \"target\": null\n      },\n      \"client\": null\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88407\",\n      \"actor\": \"system\",\n      \"actor_id\": null,\n      \"type\": \"participant.invitation.created\",\n      \"timestamp\": \"2026-09-24T11:16:15.911Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88212\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88322\",\n      \"delivery\": {\n        \"type\": \"sms\",\n        \"target\": \"+358401234567\",\n        \"message\": \"Please sign by Friday.\"\n      },\n      \"client\": null\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88408\",\n      \"actor\": \"integrator\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88001\",\n      \"type\": \"session.started\",\n      \"timestamp\": \"2026-09-24T11:16:19.647Z\",\n      \"client\": {\n        \"ip\": \"203.0.113.10\",\n        \"user_agent\": \"PostmanRuntime/7.56.1\"\n      }\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88409\",\n      \"actor\": \"system\",\n      \"actor_id\": null,\n      \"type\": \"participant.invitation.sent\",\n      \"timestamp\": \"2026-09-24T11:16:19.974Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88312\",\n      \"delivery\": {\n        \"type\": \"email\",\n        \"target\": \"john.doe@example.org\"\n      },\n      \"client\": null\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f8840a\",\n      \"actor\": \"participant\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"type\": \"participant.invitation.opened\",\n      \"timestamp\": \"2026-09-24T11:16:57.698Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"invitation_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88312\",\n      \"delivery\": {\n        \"type\": \"email\",\n        \"target\": \"john.doe@example.org\"\n      },\n      \"client\": {\n        \"ip\": \"203.0.113.20\",\n        \"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\"\n      }\n    },\n    {\n      \"id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f8840b\",\n      \"actor\": \"participant\",\n      \"actor_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"type\": \"participant.signing.identity-proven\",\n      \"timestamp\": \"2026-09-24T11:17:05.000Z\",\n      \"participant_id\": \"0196ae5b-2e9d-729f-aba5-fa4db6f88211\",\n      \"identity_proof\": {\n        \"auth_type\": \"eid\",\n        \"auth_channel\": \"fi_nordea\",\n        \"identity\": {\n          \"name\": \"John Doe\",\n          \"date_of_birth\": \"1990-01-15\"\n        },\n        \"prover\": {\n          \"name\": \"Telia Tunnistus\",\n          \"proof_id\": \"bank-session-42\"\n        },\n        \"proven_at\": \"2026-09-24T11:17:05.000Z\"\n      },\n      \"client\": {\n        \"ip\": \"203.0.113.20\",\n        \"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\"\n      }\n    }\n  ],\n  \"meta\": {\n    \"status\": {\n      \"code\": 200,\n      \"text\": \"OK\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-types","__idx":1},"children":["Event types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.created"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session is created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.started"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session is started."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Every participant has signed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session is cancelled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.discarded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session is discarded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session.expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session expired before it was completed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.added"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A participant is added."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.removed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A participant is removed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.declined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A participant declines to sign."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.reinstated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A declined participant is brought back to pending."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.excused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A participant is excused from signing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.invitation.created"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An invitation is created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.invitation.sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An invitation is sent by email or SMS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.invitation.opened"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An invitation is opened."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.invitation.revoked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An invitation is revoked."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.signing.identity-proven"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The participant's identity is proven."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.signing.completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A participant signs."]}]}]}]}]}]},"headings":[{"value":"Audit log","id":"audit-log","depth":1},{"value":"Event types","id":"event-types","depth":2}],"frontmatter":{"seo":{"title":"Audit log"}},"lastModified":"2026-09-24T11:24:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/embed-api/signing/audit-log","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}