Support service reference
OpenAPI specification, XML contract data, example messages and detached CMS steps for a support service that uses Signing Server.
This page collects the machine-readable contract and the fixed values that a requesting system, here called the support service, needs when it integrates with Signing Server. The flow itself is described in Document signing with a requesting system.
Downloads
Section titled “Downloads”| File | Description |
|---|---|
| support-service.openapi.json | OpenAPI 3.1 description of POST /sign/{connection}, POST /consent/{connection} and the browser return to the support service's own receiver, which is described as a webhook. |
| support-service.xml-contract.json | The fixed DSS values: profile, namespaces, algorithms, limits, result codes, message display rules and the generic XML/PDF/CMS and the selected PAdES/XAdES profiles and the separately registered local JAdES binding. |
The OpenAPI file describes the HTTP boundary. A generated client does not implement the browser ceremony, the signing of the request envelope or the verification of the response, so follow the integration guide for those parts.
The XML schemas are the OASIS DSS core schema oasis-dss-core-schema-v1.0-os.xsd and the Sweden Connect DSS extension schema EidCentralSigDssExt-1.1.4.xsd. Obtain them from their publishers and validate offline with a pinned local copy rather than resolving them over the network.
Additional profiles
Section titled “Additional profiles”Signature formats covers exact UTF-8 text, PAdES, XAdES and JAdES. The XAdES lifecycle covers consumer-only B-T/B-LT/B-LTA with the unchanged XML/BES task; the server receives no Baseline-level field or unsigned augmentation. The JAdES lifecycle covers B-B/B-T/B-LT/B-LTA with preserved encoded history, complete CRLs and consumer renewal over the unchanged local signing binding. The local JAdES XSD defines its separate task collection. CSC signing uses its own HTTP/OAuth contract.
The PAdES guide documents the PDF/BES binding and complete-level consumer workflow. Its task fragment and metadata are historical preparation illustrations, separate from the generic complete exchanges below.
Fixed values
Section titled “Fixed values”| Value | Setting |
|---|---|
| Binding | POST/XML/1.0 |
| Profile | http://id.elegnamnden.se/csig/1.1/dss-ext/profile, implementation profile 1.7 |
| Extension | Version 1.6, namespace http://id.elegnamnden.se/csig/1.1/dss-ext/ns |
| DSS core namespace | urn:oasis:names:tc:dss:1.0:core:schema |
| Request envelope signature | http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 |
| Digest | http://www.w3.org/2001/04/xmlenc#sha256 |
| Canonicalization | http://www.w3.org/2001/10/xml-exc-c14n# |
RequestID pattern |
[A-Za-z0-9][A-Za-z0-9._:-]{19,95} |
| Standard task types | Generic XML, PDF, CMS use AdESType omitted or None; selected XAdES uses XML/BES and its exact rule/object; selected PAdES uses PDF/BES and its exact certificate-bound rule. |
| Local JAdES profile | urn:se:idombud:signing:dss:jades:v1, default-off per requester, with a separate local task collection. |
| Message formats | text and text/markdown |
Limits
Section titled “Limits”| Limit | Value |
|---|---|
| Encoded form | 131,072 bytes |
| Decoded XML | 65,536 bytes, depth 32, 4,096 nodes |
| Tasks per request | 1–8 |
| Decoded bytes per task | 8,192 |
| Message | 2,048 bytes of UTF-8. Markdown up to 256 nodes and 32 levels. |
| Request lifetime | 180 seconds from RequestTime, shortened by NotOnOrAfter |
| Pending requests per connection | 64 |
These limits describe what Signing Server accepts. Set your own limits for the response and allow for the certificate and signature overhead when you choose batch sizes.
Result codes
Section titled “Result codes”The major code is urn:oasis:names:tc:dss:1.0:resultmajor: followed by Success, RequesterError or ResponderError. The minor codes are:
| Minor | URI |
|---|---|
NotSupported |
urn:oasis:names:tc:dss:1.0:resultminor:NotSupported |
req-expired |
http://id.elegnamnden.se/sig-status/1.0/req-expired |
user-cancel |
http://id.elegnamnden.se/sig-status/1.0/user-cancel |
user-mismatch |
http://id.elegnamnden.se/sig-status/1.0/user-mismatch |
sigmessage-error |
http://id.elegnamnden.se/sig-status/1.0/sigmessage-error |
authn-failed |
http://id.swedenconnect.se/sig-status/1.1/authn-failed |
security-violation |
http://id.swedenconnect.se/sig-status/1.1/security-violation |
Not provided
Section titled “Not provided”The interface has no transaction status or polling API, no server-to-server result notification, no retry or exactly-once delivery guarantee, no remote cancellation, no resuming of a pending browser ceremony after a restart, no HTML messages and no external time stamping or long-term validation.
Example messages
Section titled “Example messages”The examples illustrate the supplied/static XML/PDF signing and service-cancellation profiles. They use generic non-AdES PDF and are not examples of CSC, fresh dynamic credentials, PAdES, XAdES or JAdES. The examples are complete exchanges that were captured from a real Signing Server and are public and synthetic. They are consumed and expired, so they cannot be replayed, and their keys must never be registered as trust. The forms show the field values before URL encoding. The real content type stays application/x-www-form-urlencoded.
| Exchange | Files |
|---|---|
| Successful XML and PDF signing | request, request form, response, response form, public keys |
| Cancellation in Signing Server | request, request form, response, response form, public keys |
| Index | manifest.json lists the exchanges and the SHA-256 of each file. |
The public keys are Base64 DER SubjectPublicKeyInfo for RSA. The requester key verifies request envelopes, and the service envelope key verifies response envelopes. The success response also carries the public document signing certificates. The request carries prepared XML SignedInfo and PDF CMS SignedAttrs, never the original documents. Changing any identifier, time, destination, input or the formatting invalidates the signed envelope, so build a new request and sign it with your own registered key.
Detached CMS for any file
Section titled “Detached CMS for any file”Use SigType CMS to have a text, image, archive or other file signed as a detached CMS signature. The original stays with the support service, and the connection, requester registration, signed envelope, message, authentication and approval are the same as for XML and PDF.
<csig:SignTaskData xmlns:csig="http://id.elegnamnden.se/csig/1.1/dss-ext/ns" SigType="CMS" SignTaskId="file-1" ProcessingRules="urn:se:idombud:signing:cms:detached-sha256-rsa:v1"> <csig:ToBeSignedBytes>BASE64_OF_DER_SIGNED_ATTRIBUTES</csig:ToBeSignedBytes></csig:SignTaskData>The fragment is unsigned and goes into the existing SignTasks element before you sign the whole envelope. ProcessingRules is required for CMS and rejected for generic XML/PDF. Selected XAdES and PAdES each require their own exact rule with AdESType="BES"; see Signature formats.
- Keep the exact original bytes. Compute SHA-256 of the original and put it in the single
messageDigestattribute, together with the singlecontentTypeid-data. - DER-encode the set of attributes including the universal tag
0x31, and send its Base64 asToBeSignedBytes. Do not send the original, a finished CMS or only the file digest. The server signs the SHA-256 of the attributes, not the digest of the original. - Verify the signed response with the registered service envelope key. Match
RequestID,RelayState, the ordered task IDs and types, the exactProcessingRulesand your retained attribute bytes. Check that the signature isrsa-sha256and that the certificate is the credential you expect. - Assemble CMS
SignedDatawithid-data, an absenteContent, the returned public chain, an issuer and serial signer identifier, SHA-256 and the RSA signature. EncodesignedAttrswith implicit[0]insideSignerInfo, while the signed bytes remain the universal set encoding from step 2. If you usecmsAlgorithmProtect, copy its exact algorithm identifiers intoSignerInfo. Do not sign again and do not change any attribute. - Verify the final CMS against the retained original and your accepted certificate trust. An altered original, signature,
messageDigestor other attribute must fail. Deliver the CMS and the original as separate files.
If you include signingTime, it is only a claim by the requester. Choose a time that your certificate validity policy allows.
Describe the signing action accurately in SignMessage and keep the link between the original and the message in your own system. Signing Server cannot see the file and cannot tell a false messageDigest from a true one, so only your own verification of the original catches that. Supplied-credential signing does not itself issue a personal certificate. Optional external PKI and dynamic person signing require their explicit configuration and verified identity binding. Configure certificate trust explicitly for every selected lifecycle.