API Reference
Audit logs
Every action in your SwiftProof account is recorded. Query the log to monitor activity, debug issues, and satisfy compliance requirements.
GET /v1/logs
Retrieve audit log entries for your project. Returns the 50 most recent entries by default, ordered newest first.
| Query param | Type | Description |
|---|---|---|
| limit | integer | Number of entries. Default 50, max 500. |
| chain_id | string | Filter to a specific chain. |
| event_type | string | Filter by event type. See event types below. |
| from | string | ISO 8601 start time for the query window. |
| to | string | ISO 8601 end time for the query window. |
| before | string | Cursor for pagination. Pass log_id of last result. |
Log entry object
| Field | Type | Description |
|---|---|---|
| log_id | string | Unique identifier for this log entry. |
| event_type | string | The type of event that occurred. |
| chain_id | string | Associated chain, if applicable. |
| handoff_id | string | Associated handoff, if applicable. |
| actor | string | Who performed the action. |
| metadata | object | Additional context specific to the event type. |
| created_at | string | ISO 8601 timestamp. |
Event types
| Event type | Description |
|---|---|
| chain.created | A new chain was created via the API. |
| chain.completed | All handoffs confirmed. Chain is now closed. |
| chain.failed | One or more links expired before confirmation. |
| handoff.confirmed | An actor confirmed their step via the confirmation link. |
| handoff.expired | A confirmation link passed its expiry time unconfirmed. |
| handoff.resent | A fresh confirmation link was issued to replace an old one. |
| link.opened | An actor opened a confirmation link without yet confirming. |
| verification.requested | A chain verification was performed via the API. |
Audit logs are retained for 24 months. For compliance use cases requiring longer retention, contact hello@tryswiftproof.com.