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

# Get process status

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

## Request

- Base URL: `https://sign.swisscom.ch/system`
- URL: `https://sign.swisscom.ch/system/api/process/{processId}/status`
- 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/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the current status of the process. Requires that the process exists and the caller is authorized.

## Path parameters

- `processId` string, uuid, required

## Response `200`

Returns the state of the desired document.

- ProcessStatusResponse: Response object containing the status of a process.
  - `id` string, uuid: System-assigned process identifier.
  - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'EXPIRED': Current lifecycle state of the process.

## 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)