This is not a Signatus API endpoint. It is an endpoint that you implement in your backend. Signatus calls it (HTTPS POST) when an envelope or a signing round is completed. You choose the URL and register it via the sendInfo rule.
If the call to your endpoint fails, i.e. your backend responds with any HTTP status other than 200 OK, Signatus retries the call every 10 minutes. In the current version there is no limit on the number of retries, Signatus keeps retrying until it receives 200 OK.
Envelope info service specifications #
Endpoint in portal backend, where Signatus sends information about the completed envelope or about a completed process (signing round) in a multi-round envelope. The envelope notification and the process notifications are configured independently, so each of them can point to a different endpoint in the portal backend.
| URL | /envelope-info URL to endpoint will be added in request : rules.sendInfo |
| Method | POST |
| Authentication | NONE |
| Content Type | application/json |
Envelope info notification #
When an envelope is completed, Signatus sends information about it to the portal backend. An envelope is completed when all of its processes (signing rounds) are finished. This notification lets the portal react to the final state of the envelope, e.g. update the status in its own system, download the signed documents or notify the participants.
To enable this notification, the URL of the portal endpoint must be set in the envelope rules using the sendInfo rule without any suffix. The notification is sent once, after the whole envelope is completed, and the payload contains information about the envelope including all of its processes in the processes array.
Rules example to set envelope info URL :
{
"rules": {
"sendInfo": "https://portalbackend.com/envelope-info"
}
}Request body example :
{
"id": "2a79588d-f722-4293-94c1-61e6594c0ff9",
"userId": "demo.api",
"created": 1713529170826,
"updated": 1713529180532,
"state": "final",
"envelopetypeid": 4,
"expirationtime": 1755767728640,
"extension": {},
"processes": [
{
"id": "92d4cfd2-2170-449a-8989-2d049ad0882e",
"userId": "demo.api",
"envelopeid": "2a79588d-f722-4293-94c1-61e6594c0ff9",
"signer": "client",
"state": "final",
"extension": {},
"sigtype": "bio",
"envelopetypeid": 4,
"tenant": "demo"
},
{
"id": "47aa3bf0-7381-4a44-b93f-a0cf22880fba",
"userId": "demo.api",
"envelopeid": "2a79588d-f722-4293-94c1-61e6594c0ff9",
"signer": "approver",
"state": "final",
"extension": {},
"sigtype": "data",
"envelopetypeid": 4,
"tenant": "demo"
}
],
"type": "inbox",
"folder": "Contract",
"name": "Contract no. 1245726",
"source": "api",
"product": [],
"contact": {},
"tenant": "demo",
"rules": {
"guiSignerName.client": "John Client",
"mouseSignature": false,
"guiSignerName.approver": "Jack Employer",
"emailTo.client": "client@company.com",
"emailTo.approver": "approver@portal.com",
"emailFrom": "approver@portal.com",
"nameFrom": "Jack Employer",
"openOtpPhone.client": "+421907863752",
"emailFinal": "client@company.com",
"sendInfo": "https://portalbackend.com/envelope-info"
}
}Process info notification (multi-round envelopes) #
On a multi-round envelope, Signatus can also notify the portal backend each time a single process is completed. A process is one finished signing round of the envelope. This lets the portal react to the progress of the envelope (e.g. update the status in its own system, notify the next participant) without waiting for the whole envelope to be completed.
To enable this notification, the rule must be assigned to a specific process using the dot notation {ruleName}.{signer}, where signer is the value of the processes.signer attribute. The notification is sent only for the process identified by the signer.
Rules example to set process info URL for the process with signer client :
{
"rules": {
"sendInfo.client": "https://portalbackend.com/envelope-info"
}
}The process-level rule can be combined with the envelope-level rule. In that case, the portal receives a notification after the specified process is completed and another one after the whole envelope is completed:
{
"rules": {
"sendInfo.client": "https://portalbackend.com/envelope-info",
"sendInfo": "https://portalbackend.com/envelope-info"
}
}The payload sent after a process is completed is different from the payload sent after the envelope is completed. It contains information about the completed process only, not about the whole envelope. If the same endpoint is used for both envelope and process notifications, the portal backend can distinguish the two payloads by their content: the process payload contains the signer and documentsProcess attributes, while the envelope payload contains the processes array.
Request body example:
{
"extension": {},
"created": 1791543835102,
"rules": {},
"userId": "demo.api",
"sigtype": "bio",
"envelopeid": "2a79588d-f722-4293-94c1-61e6594c0ff9",
"documentsProcess": [
{
"filename": "file1",
"data": {},
"method": "write",
"processid": "92d4cfd2-2170-449a-8989-2d049ad0882e",
"created": 1791543835152,
"envelopeid": "2a79588d-f722-4293-94c1-61e6594c0ff9",
"documentid": "01a12055-7995-771c-a988-de5e8c72891f",
"state": "final",
"updated": 1791544044906
}
],
"id": "92d4cfd2-2170-449a-8989-2d049ad0882e",
"state": "final",
"updated": 1791543857243,
"tenant": "demo",
"envelopetypeid": 4,
"signer": "client"
}