SWswisscom
Process: create

Release process and notify participants

Releases a previously created and fully configured process. Personal access URLs are returned for each participant. These can be used for asynchronous execution, typically via email.

Optionally, you may include email parameters to notify participants directly. Optionally, you may configure automatic reminder emails for pending participants. Optionally, you may restrict the allowed signature methods (APP, CLICK, OSS, PASSKEY, SMS) via signatureMethods. If omitted, the tenant defaults apply. Methods are validated against the document's signature level. Optionally, you may opt signers into workflow actions (DECLINE, DELEGATE, REMOVE, REPLACE) via signerCapabilities. If omitted, no signer actions are permitted. These actions are only activated via this endpoint; they are executed via the Swisscom Sign UI, not directly through the API. Optionally, you may enforce a serial signing order via signingOrder: SERIAL, gated by each signer's signingIndex (set at creation). If omitted, defaults to PARALLEL.

Preconditions:

  • A process was created via /process with at least one participant.
  • At least one document was attached using /process/{processId}/attach.
  • Every signer must be placed on at least one document.
  • At least one document must have all signers placed on it.
  • All visual signatures are placed within the visible area.
post/api/process/{processId}/release

Request

Path parameters

processIdstring uuid required

Unique identifier of the process to be released.

Request body

validUntilstring date-time

Expiration timestamp of the process. After this point in time, the system automatically transitions the process status to EXPIRED. If not provided, the valid until date is automatically set to 30 days in the future.

languagestring

Deprecated: Use notification.locale instead.

Legacy behavior: Setting this field enables all notification types (INVITE, COMPLETION) for all participants in the specified language.

If both language and notification.locale are provided, notification.locale takes precedence.

Supported values: en-GB, de-CH, fr-CH, it-CH (BCP-47).

signatureMethodsstring[] nullable

Optional list of allowed signature methods for this process. If not provided, the tenant defaults are used.

Available methods:

  • APP – Mobile app-based authentication via Swisscom Mobile ID.
  • CLICK – Click-to-sign: the signer confirms by clicking, without further authentication (SES only). Identity assurance is based on the process access authorization (e.g. email or SMS).
  • OSS – One-Shot Signing: on-the-fly authentication without prior device registration. Ideal for one-time or infrequent signers. Corporate tenants only.
  • PASSKEY – WebAuthn passkey authentication. Corporate tenants only.
  • SMS – One-time password (OTP) delivered via SMS.

Compatibility with signature levels:

  • SIMPLE → CLICK
  • ADVANCED → APP, OSS, PASSKEY, SMS
  • ADVANCED_EU → APP, OSS, PASSKEY
  • QUALIFIED / QUALIFIED_EU → APP, OSS, PASSKEY
signingFeaturesstring[] nullable

Optional set of opt-in signing features for this process. If not provided, the tenant defaults are used.

Available features:

  • SIGN_IDENT_DOCUMENT – Document produced by online identification is co-signed within the process.
signerCapabilitiesstring[] nullable

Opt-in signer actions permitted in the process. If not provided, no signer actions are permitted.

Available actions:

  • DECLINE – Signer may decline signing.
  • DELEGATE – Signer may delegate to another person.
  • REMOVE – An invited signer may be removed.
  • REPLACE – An invited signer may be replaced.
signingOrder'PARALLEL' | 'SERIAL' nullable

Signing order for the process. Defaults to PARALLEL if not provided.

  • PARALLEL – All signers may sign in any order.
  • SERIAL – Signers sign one after another, per each signer's signingIndex (missing signingIndex is treated as 0; ties are broken by invitation order).

Example request

{
  "notification": {
    "locale": "de-CH",
    "suppress": [
      "INVITE"
    ]
  }
}

Response

Process released; participant URLs returned (permanently valid).

idstring uuid

System-assigned identifier of the released process.

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

Lifecycle status after release. Typically PENDING (waiting for signatures).

Example response

{
  "id": "6f1a5c4d-2d9a-4f12-a1c5-bc6e2bcb2d6a",
  "status": "PENDING",
  "participants": [
    {
      "id": "02c2f3cc-e263-40c9-b458-79c014a153a2",
      "externalIdentifier": "crm-4711",
      "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.