If an Approver refuses to validate a Signature Request, it is possible for him to add a refusal reason. This value can be retrieved in theapprover.rejected webhook's payload.
A new field exists! You can create the Radio Buttons Fields. It is an alternative to Checkbox fields if you only need to select one of several options.
It is possible to create them either with smart anchors or manually: https://developers.yousign.com/docs/fields-creation-new
You find the checkboxes too big for your document? It is now possible to choose the size of the checkbox fields. Make them fit your document size!
This option is available for smart anchors and manual fields creation:
Creating a checkbox without the size parameter is now considered deprecated but you don't need to change anything in your code, it will still work and it is not planned to be suppressed.
All new integrations should add this sizeparameter for checkbox creation.
Workspaces allow you to ensure the confidentiality of documents between your users or reflect the organization of your company (departments, subsidiaries, agencies...).
When you create a Signature Request you can choose to store it in a specific Workspace. Otherwise, the Signature Request will be stored in the oldest active workspace.
More details about Workspaces can be found here.
Electronic Seal allows a company (moral entity) to seal on a file without any signature request configuration..
New endpoints
https://developers.yousign.com/reference/post-electronic-seals
New events
In addition, two new webhook events are created:
| Event | Description |
|---|---|
electronic_seal.done | The document is stamped and the Electronic seal status is done |
electronic_seal.error | An error occurred during Document stamping and the Electronic seal status is in error |
A new event signer.erroris available. It notifies you when a Signer failed to sign due to an internal error during the signing process, in that case, the Signature Request is automatically cancelled.
This error can be due to a corrupted document for example.
If the error persists, don't hesitate to get in touch with your dedicated counsellor.
Documents from a Signature Request can now be downloaded one by one. All you need to do is use this endpoint and provide the signatureRequestId and the documentId. A .pdf file will be sent as a response.
It is now possible to manage your Custom Experiences from the API, in addition to the application.
You no longer need to use the Yousign application to create and modify your Custom Experiences: it is now possible to do so directly from the API! You can find all your creations in your application.
New endpoints to use:
POST /custom_experience
GET /custom_experience
PATCH /custom_experience
DELETE /custom_experience
Link to the dedicated page on the documentation: https://developers.yousign.com/docs/custom-experiences-new
We talk about the Custom Experience and no more Branding.
🤔 Why?
Because the word Branding is not wide enough to designate everything that can be set-up. The term Custom Experience is more appropriate and reflect in-app naming.
So, this change is expected to be reflected in the API code.
Technical change:
branding_id it's replace by custom_experience_id in signature_requests payload and responses.
branding_id is deprecated but you don't need to change anything in your code, it will still work and it is not planned to be suppressed.
It is the new property name and it should be used for new implementations.