How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Swisscom Process: read API

Access process information and download signed or original documents once the signing is complete.

Swisscom Process: read API is one of 14 APIs that Swisscom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Process: read. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and a changelog.

This API exposes 7 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against a single base URL, https://sign.swisscom.ch/system.

7 operations 7 paths 23 schemas 6 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://sign.swisscom.ch/system
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Swisscom Process: read API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (SwisscomSignOAuth2) using the clientCredentials flow, exposing 3 scopes. By default, every request must be authenticated.

  • SwisscomSignOAuth2 — OAuth 2.0 Client Credentials flow for accessing the Swisscom Sign Integration API.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Process: read 7

Access process information and download signed or original documents once the signing is complete.

GET
/api/process
Get all processes (paginated)
findAll 6 params → 200400401
POST
/api/process/{processId}/open/{personId}
Generate participant access URL
open 2 params body → 200401409
GET
/api/process/{processId}
Get process details
getProcess 1 param → 200401404409
GET
/api/process/{processId}/status
Get process status
getStatus 1 param → 200401404409
GET
/api/process/{processId}/record
Get auditing records
getRecords 1 param → 200401409
GET
/api/process/{processId}/file/{fileId}
Download process file
getFile 2 params → 200401409410412
GET
/api/process/{processId}/file/{fileId}/content
Download process file content
getFileContent 2 params → 200401409410412

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Process (16 properties), Signer (15 properties), Error (8 properties), ProcessOpenRequest (8 properties). Each schema is shown below with its type and property counts.

FileSignaturePositionInput
object
Polymorphic signature position for the attach request (write-only). The 'locator' field selects the concrete shape: - COORDINATES (default): place the signatur…
1 property 1 required
CoordinateSignaturePosition
Signature position defined by explicit page and coordinates (PDF points). Default when 'locator' is absent.
4 required
AuditSuccessRecordResponse
object
Response containing a list of auditing records for a process
1 property
Signer
object
Human participant who signs. The 'type' discriminator must be 'SIGNER'.
15 properties 3 required
Process
object
A process represents an end-to-end signing flow with 1..n signers over 1..n documents. The initiator can optionally sign; additional signers are listed in invi…
16 properties 1 required
AuditRecord
object
A single audit trail entry describing an action that occurred at a specific time.
5 properties
TagSignaturePosition
Signature position located by searching for a default tag string in the PDF (\s1\ for index 0, \s2\ for index 1, etc.). The tag marks the upper-left corner of…
1 required
Participant
object
Polymorphic participant. The 'type' discriminator selects the concrete shape.
1 property 1 required
PageMetadata
object
Stable pagination metadata.
4 properties
FileReference
object
Reference to an uploaded file with its versions and signature positions.
4 properties
Error
object
Error object returned in case of an unsuccessful request.
8 properties
ProcessPage
object
Paginated list of processes.
8 properties
Invitees
object
Invitees represent the additional signers to be invited for this process. The process initiator may optionally sign as well; if the initiator is a signer, they…
2 properties
Property
object
A single property (key/value) that can be attached to the process. Keys must be unique within the process.
2 properties 2 required
ProcessOpenResponse
object
Response with the deep link to open the process in Swisscom Sign UI.
2 properties
ProcessStatusResponse
object
Response object containing the status of a process.
2 properties
FileAttachment
object
Represents the configuration for attaching a PDF to a Process
6 properties 3 required
ProcessAuthentication
object
INTERNAL ONLY: Authentication for the first-party namespace. Requests from other clients are ignored.
2 properties 2 required
NonPerson
Technical participant (non-human). The 'type' discriminator must be 'NONPERSON'.
2 required
ProcessOpenRequest
object
Request to open a signing process for a specific participant.
8 properties
FileSignaturePosition
object
Represents the position of a signature in a file attachment.
5 properties 4 required
Person
Human participant who does not sign. The 'type' discriminator must be 'PERSON'.
1 required
Verification
object
Online identity verification (GwG) for a signer. Only available for clients of type Corporate. Providing this object in non-corporate context will cause the cr…
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

swisscom-process-read-api-openapi.yml Raw ↑

Other APIs Swisscom publishes across the network.

Swisscom Text Messaging (SMS) API
Swisscom Phone Number Validation API
Swisscom Receive SMS API
Swisscom Heatmaps API
Swisscom Dwell Times API
Swisscom Origin Destination API
Swisscom Smart Catalogs for NATEL go API
Swiss AI Platform Inference Endpoints API
Swisscom Business Identity Validator API
Swisscom Voice VoIP API
Swisscom Voice Mail API
Swisscom Process: create API
Where this information came from

This is an independent, third-party profile of Swisscom Process: read API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.