---
title: "Get auditing records"
method: GET
path: "/api/process/{processId}/record"
tags: ["Process: read"]
---

# Get auditing records

`GET /api/process/{processId}/record`

## Request

- Base URL: `https://sign.swisscom.ch/system`
- URL: `https://sign.swisscom.ch/system/api/process/{processId}/record`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sign.swisscom.ch/realms/swisscom-public/protocol/openid-connect/token` scopes: `sswp:process:read`
- TypeScript: <https://skmtc.dev/swisscom/apis/swisscom-sign-integration-api/docs/api/process/:processId/record/get.ts> (a function with typed inputs; its response is checked against the schema)

This service can be used only with a valid process. All created auditing records are returned in descending order of creation date. Thus, the first record is the most recent.

## Path parameters

- `processId` string, uuid, required

## Response `200`

Returns a list of auditing records.

- AuditSuccessRecordResponse: Response containing a list of auditing records for a process
  - `records` AuditRecord[]: Audit records ordered by creation date descending.
    - `id` string, uuid: Unique identifier of this audit record.
    - `createdDate` string, date-time: Timestamp when the record was created (UTC).
    - `action` string: Action label describing what happened. Common values include: * `sign` – A signature was performed. * `email` – An email was sent. * `payment` – A payment was successfully processed. * `identification` – A verification or onboarding step was completed. * `transaction` – The process completed (fully signed or discontinued).
    - `status` 'INITIALIZE' | 'ABORT' | 'FAIL' | 'SUCCESS' | 'UNKNOWN': Result of the action.
    - `extras` object: Additional action-specific data as key/value pairs. Values may be primitives or small JSON objects depending on the action. Example keys: * `extras.sign_signatureLevel` : "QUALIFIED" * `extras.email_type` : "INVITE"

## Other responses

- `400`: Invalid request – the process ID is no UUID.
- `401`: Authorization information is missing or invalid.
- `403`: Forbidden – the token lacks the scope `sswp:process:read`.
- `404`: Process not found, or it does not belong to the organization of the token.
- `409`: Occurs when there is a general error.

---

[API](https://skmtc.dev/swisscom/apis/swisscom-sign-integration-api.md) - [All operations](https://skmtc.dev/swisscom/apis/swisscom-sign-integration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/swisscom/apis/swisscom-sign-integration-api/revisions/c7d25e820106?raw)