Enterprise migration guide
We now support our existing Enterprise Electronic Signing solutions on our new Digital Trust Platform (DTP). If you are a new customer or have recently migrated to our new platform, the following guide will provide an overview of the changes.
Enterprise Sign API
URL and API authorisation
See our guide on setting up an API integration.
Our new platform introduces new endpoints for our established products:
| API | New API URL | Old API URL |
|---|---|---|
| Enterprise Sign API | https://api.signicat.com/enterprise/sign | https://id.signicat.com/sign |
Error responses
Our platform will return error responses in the Problem Detail RFC format for all errors that occur before the request is forwarded. The potential errors that can arise before the request is forwarded are:
- 4xx errors
- 5xx errors
- Token validation errors
- Errors relating to validation of the request URL path or parameters
- Errors relating to general validation of correct HTTP verb, URL parameters, payloads, not empty payload if required
- Errors relating to dependencies in our new platform, such as global configuration
If the response Content-Type is text or JSON, all URLs containing the full URL of the existing (Enterprise) API will get replaced with a https://api.signicat.com URL with the enterprise prefix path.
Enterprise SOAP web services
Our Enterprise SOAP web services are available to existing customers only. If you are working on a new integration or are planning to upgrade from an older version of our DocumentService, PackagingService or ArchiveService SOAP APIs, we strongly recommend that you use our RESTful Sign API instead.
URL and API authorisation
See our guide on setting up an API integration.
Our new platform introduces new endpoints for our established products:
| API | New API URL | Old API URL |
|---|---|---|
| Enterprise SOAP web services gateway | https://api.signicat.com/enterprise/ws/ | https://id.signicat.com/ws/ |
MTLS client certificates are now replaced with a JWT authorisation header using the Bearer scheme. Note that any errors as a result of JWT token validation will produce new error messages, but will retain the SOAP error format.
Retrieving the access token
Retrieve your access token in the same way you would for the REST services on our new platform. For details, see our step-by-step guide, Accessing API products.
Using the access token
Add your access token to the SOAP request header in the same way you would for a REST request header. Refer to your client library documentation for information on how to set the header in your specific case. For example, if you use the Java CXF library, you can set the header through the requestContext of BindingProvider.
Uploading documents
If you are an existing customer using DocumentService v3 and PackagingService v4 and have recently migrated to our new platform, documents are now uploaded to our Sign API's built-in Session Data Storage (SDS) by using the documents endpoint.
For more information, see our guide on setting up an API integration.
Retrieving documents
To retrieve documents, use the same endpoints that are established in our REST Sign API:
- For documents in Session Data Storage (SDS), use the documents endpoint.
- For archive documents, use the archive-documents endpoint.
Error responses
Our platform will return error responses in the Problem Detail RFC format for all errors that occur before the request is forwarded. The potential errors that can arise before the request is forwarded are:
- 4xx errors
- 5xx errors
- Token validation errors
- Errors relating to validation of the request URL path or parameters
- Errors relating to general validation of correct HTTP verb, URL parameters, payloads, not empty payload if required
- Errors relating to dependencies in our new platform, such as global configuration
If the response Content-Type is text or JSON, all URLs containing the full URL of the existing (Enterprise) API will get replaced with a https://api.signicat.com URL with the enterprise prefix path.