SWswisscom
Process: manage

Cancel a pending process

Cancels a pending process. All signers with status WAITING or PENDING get the status CANCELED and lose access to the process. Afterwards, the process status changes to COMPLETED and all participants receive a completion notification, unless COMPLETION or ALL has been suppressed via notification.suppress when releasing the process.

Preconditions:

  • The process must have the status PENDING.
post/api/process/{processId}/cancel

Request

Path parameters

processIdstring uuid required

Unique identifier of the process.

Response

The process has been canceled and is returned in its new state.

idstring uuid

System-assigned process identifier.

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

Current lifecycle state of the process.

signatureLevel'SIMPLE' | 'ADVANCED' | 'ADVANCED_EU' | 'QUALIFIED' | 'QUALIFIED_EU'

Legal quality of the signature(s).

teamIdstring uuid nullable

Optional identifier of an existing team to which the process will be assigned. The team must be created in the cockpit beforehand and the teamId can be retrieved there. If provided, the process will be visible to all members of the specified team. The team assignment cannot be modified after the process is created.

payloadstring

Optional opaque application payload for correlation/auditing. May contain a JSON string.

validUntilstring date-time

Expiration timestamp of the process. After this point in time, the system automatically transitions the process status to EXPIRED.

createdDatestring date-time

Creation timestamp (UTC).

lastModifiedDatestring date-time

Last modification timestamp (UTC).

archiveOnstring date-time

Scheduled archival time, if any (UTC).

archivedOnstring date-time

Actual time when archival happened, if archived (UTC).

partnerIdstring nullable

Optional partner identifier. If provided, it must reference an existing partner.

authorization'CODE' | 'ACCOUNT'

Authorization requirements for accessing the process.

signingOrder'PARALLEL' | 'SERIAL' nullable

Signing order of the process.

  • PARALLEL – All signers may sign in any order. Default value, including before the process has been released.
  • SERIAL – Signers sign one after another, per each signer's signingIndex. Only takes effect once the process has been released with signingOrder: SERIAL.

Example response

{
  "signatureLevel": "QUALIFIED",
  "initiator": {
    "type": "NON_PERSON",
    "externalIdentifier": "ext-systems_oms-42",
    "name": "Swisscom Sign Orchestrator"
  },
  "invitees": {
    "personalMessage": "Hello, please sign. Thank you!",
    "signers": [
      {
        "type": "SIGNER",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "status": "PENDING"
      }
    ]
  },
  "properties": [
    {
      "key": "contractType",
      "value": "NDA"
    },
    {
      "key": "department",
      "value": "Legal"
    }
  ],
  "payload": "{ \"caseId\": \"ABC-42\", \"priority\": \"HIGH\" }",
  "validUntil": "2025-12-31T23:59:59Z"
}

Changes

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