Process: read

Get process status

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

get/api/process/{processId}/status

Request

Base URL
https://sign.swisscom.ch/system
Auth
OAuth 2
Client credentials
Token URLhttps://sign.swisscom.ch/realms/swisscom-public/protocol/openid-connect/token
Scopessswp: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.

processIdstring uuid required

Returns the state of the desired document.

idstring uuid

System-assigned process identifier.

status'CREATED' | 'PENDING' | 'COMPLETED' | 'EXPIRED'

Current lifecycle state of the process.

{
  "id": "4b2b6a3e-9c1d-41b5-87e1-2c7b1f9a7e21",
  "status": "PENDING"
}

No recorded changes to this operation across all 1 revision of this API.