Express migration guide
We now support our existing Express 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.
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 |
---|---|---|
Express Signature API | https://api.signicat.com/express/sign | https://api.signicat.io/signature |
Custom domains
Domain setup is now self-serviceable through our Dashboard. See our documentation on adding a domain for details.
Signature events
Events such as webhooks are now self-serviceable through our Dashboard. See our new Events and webhooks documentation for information on setting up and managing events.
Note that the names and content of the events have changed in our new platform. Additionally, events in our new platform contain no personally identifiable information, only IDs.
The table below shows the differences in event names between our old and new platforms.
Old event name | New event name |
---|---|
document_before_deleted | order.tobedeleted |
document_canceled | order.canceled |
document_created | order.created |
document_deleted | order.deleted |
document_expired | order.expired |
document_email_opened | email.opened |
document_link_opened | session.started |
document_packaged / document_signed | order.completed |
document_partially_signed | recipient.completed |
document_read | session.document.presented Note that the id property in the event will be the documentId from the API. The documentId property may be the documentId or the attachmentId . |
Communication (SMS / Email notifications)
Notification settings are now self-serviceable through our Dashboard. See our Communication service documentation for information on managing configurations for SMS messages and email.
Validating redirect JWT tokens
You can still follow our existing Redirects guide but we have noted in the guide that you will need to use the URL https://api.signicat.com/express/sign/jwt/validate
in your POST request in step 4 to parse and validate the JWT if you are using our new platform.
Enabling ID methods
You or your onboarding manager will need to to enable the ID Methods you want to use in our Dashboard at https://dashboard.signicat.com/bca/authn.
Other changes
- We now use our new Authentication REST API for authentication-based signing. Therefore the naming of the attributes in the PAdES evidence package (JSON/XML files) have changed slightly. The same is true for the ID method attributes included in the
documentSignature.attributes
in the Signicat Signature API. - If you use our Secure Share service as an addon, note that the user interface of the latest version of Secure Share will look different from our old Secure Share service.