---
title: "Finalize process in Swisscom Sign UI"
method: POST
path: "/api/process/{processId}/setup"
tags: ["Process: create"]
---

# Finalize process in Swisscom Sign UI

`POST /api/process/{processId}/setup`

## Request

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

Launches the Swisscom Sign web interface for the initiator to complete the process setup.
This includes defining visual elements and participant data.

Once setup is complete, the process is automatically released and notifications are handled by Swisscom Sign.

**Preconditions:**
- A process was created via `/process`.
- The process has not yet been released.

## Path parameters

- `processId` string, uuid, required

## Request body

- ProcessSetupRequest: Request model for the setup endpoint of a signing process.
  - `language` string: Preferred UI language (BCP-47). Allowed: en-GB, de-CH, fr-CH, it-CH.
  - `backUrl` string: Back URL: allows the user to return from the Swisscom Sign UI to the calling application.
  - `successUrl` string: Success URL: called after signing is completed. The document ID is transferred via query parameter. Must be a GET endpoint that issues a redirect back to the original application.
  - `authentication` ProcessAuthentication: INTERNAL ONLY: Authentication for the first-party namespace. Requests from other clients are ignored.
    - `identity` string, uuid, required: Caller-side user identifier (UUID).
    - `namespace` 'MSA' | 'MSAINT', required: Logical namespace of the first-party application (restricted).
  - `scope` string: Scope: defines the scopes that are requested on the token.
  - `mode` 'DEFAULT' | 'EMBEDDED': Mode: defines the display mode of the process page.

## Response `202`

The setup request has been accepted. Please redirect to the provided URL.

- ProcessSetupResponse: Represents the response for process setup.
  - `id` string, uuid: System-assigned process identifier.
  - `url` string: URL to the Swisscom Sign UI for completing the setup of the process.

## Other responses

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

---

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