SWswisscom
Process: create

Finalize process in Swisscom Sign UI

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.
post/api/process/{processId}/setup

Request

Path parameters

processIdstring uuid required

Unique identifier of the process to finalize via UI.

Request body

languagestring

Preferred UI language (BCP-47). Allowed: en-GB, de-CH, fr-CH, it-CH.

backUrlstring

Back URL: allows the user to return from the Swisscom Sign UI to the calling application.

successUrlstring

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.

scopestring

Scope: defines the scopes that are requested on the token.

mode'DEFAULT' | 'EMBEDDED'

Mode: defines the display mode of the process page.

Example request

{
  "language": "en-GB",
  "backUrl": "https://customer.domain/sign/back",
  "successUrl": "https://customer.domain/sign/success?id=3fa85f64-5717-4562-b3fc-2c963f66afad&participant=02c2f3cc-e263-40c9-b458-79c014a153a2",
  "authentication": {
    "identity": "69924099-a57a-44f8-8cf3-9324f4c93a92",
    "namespace": "MSAINT"
  },
  "scope": "openid sswp:process:create sswp:process:execute sswp:process:manage sswp:process:read sswp:user:read sswp:user:write",
  "mode": "DEFAULT"
}

Response

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

idstring uuid

System-assigned process identifier.

urlstring

URL to the Swisscom Sign UI for completing the setup of the process.

Example response

{
  "id": "21c2f3cc-e263-40c9-b458-79c014a153a1",
  "url": "https://test.sign.swisscom.ch/cockpit/process/21c2f3cc-e263-40c9-b458-79c014a153a1"
}

Changes

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