SWswisscom
Process: read

Generate participant access URL

Generate an URL for a specific participant that can be used to open the process in the Swisscom Sign UI. Optional return URLs can be used to redirect the user back to the calling third party system. If the process has not been released yet or the signer has not been invited yet, an error is returned. For unreleased processes, /process/{processId}/setup can be used.

Preconditions:

  • The process must have been released via /process/{processId}/release.
  • A signer must not have the status WAITING. This does not apply to the initiator.
post/api/process/{processId}/open/{personId}

Request

Path parameters

processIdstring uuid required
personIdstring required

The system-assigned identifier or the external reference from your system can be used to identify the person. If several signers share the same external reference (e.g. after a replacement), the signer with status WAITING or PENDING is used.

Request body

languagestring

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

lifecycle'PERMANENT' | 'TEMPORARY'

Controls how parameters (e.g., language, URLs, authorization settings) are applied when opening the process:

  • PERMANENT – Configuration is saved to the process and reused.
  • TEMPORARY – Configuration only applies to this request.
skipAuthorizationboolean

If true, the response URL includes a short-lived one-time code that is redeemed immediately when opening the URL (valid for ~15 minutes, single use). This bypasses the usual pre-step challenge but still enforces full authorization by the system. If false (default), the user must pass the standard authorization flow after opening the URL.

backUrlstring

Back URL to the calling application. When set, the UI displays a Home button in the navigation that redirects the user to this URL.

successUrlstring

Success URL invoked via GET after the signing succeeded. Query parameters (e.g., process and participant identifiers) are appended by the system. The endpoint should respond with an HTTP redirect suitable for browsers.

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",
  "lifecycle": "TEMPORARY",
  "backUrl": "https://customer.example/app/back",
  "successUrl": "https://customer.example/app/success?process={processId}&participant={personId}",
  "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

You receive an URL specific to the subscriber with a defined validity period.

idstring uuid

Process identifier.

urlstring uri

Participant-specific URL to open the process.

Example response

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

Changes

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