Garrigues Signature Manager - Signature Notifications Operations

---

---

Introduction

A signature notification is the message sent to a signatory to ask for their signature on a document. This section covers the operation to search signature notifications directly by email, across signature requests, without needing to know the signature request or document identifiers beforehand.

This search complements the per-document and per-signature-request signatory listings described in the Signatories operations page, and it is the replacement for the legacy "get signatures by email" flow.

---

Operations

Search signature notifications

This endpoint searches signature notifications by signatory email and notification status.

HTTP Request

GET /api/v1/private/signature-notifications

Where

Parameter	Mandatory	Datatype	Description
email	Yes	string (email)	Signatory email address to search for. A single email is required.
status	Yes	array of string	Notification statuses to filter by. Possible values: PENDING, REVIEWED, ANSWERED, CANCELLED, INFORMED. At least one value is required.
page	No	integer	Page number for pagination.
size	No	integer	Number of items per page.
sort	No	array of string	Sorting criteria in the format field:order. Defaults to createdAt:DESC.

Example Response

{
  "records": [
    {
      "signatoryId": "950fac7e-5284-42ad-8044-3f4632678324",
      "documentId": "57081c08-08e7-4d7e-b10a-8a98d7b1b3bd",
      "signatureRequestId": "4c33124e-d444-4e97-bbaa-50375c364aca",
      "type": "ADVANCED",
      "provider": "NOTICEMAN_AND_WHATSAPP",
      "createdBy": "creator@example.com",
      "processName": "Signature Request 1",
      "dueDate": "2024-01-31T23:59:59Z",
      "signatureStatus": "READY_TO_SIGN",
      "email": "signatory@example.com",
      "phone": "123456789",
      "name": "Signatory Name",
      "surnames": "Signatory Surnames",
      "sequence": 1,
      "uniqueValidator": false,
      "registeredAt": "2023-10-23T10:34:59.483Z",
      "rejectionReason": null,
      "notification": {
        "id": "b2b16f42-8e65-4c6f-8253-ad6ded8ae111",
        "notificationId": "notif-123456",
        "status": "PENDING",
        "createdAt": "2023-10-23T10:34:59.483Z",
        "updatedAt": "2023-10-23T10:34:59.483Z",
        "landingUrl": "https://noticeman.example.com/landing/notif-123456"
      }
    }
  ],
  "_metadata": {
    "currentPage": 0,
    "totalPages": 1,
    "pageSize": 20,
    "totalRecords": 1
  }
}

Notes on the response fields:

• type is the document's signature type (e.g., ADVANCED).
• provider is the effective notification provider used for this signatory.
• signatureStatus is the signatory's own signature status, while notification.status is the status of the notification message itself.
• notification.landingUrl is the URL of the notification's landing page. Its base URL is an internal implementation detail and should not be treated as contractual; only the presence and usability of the field is guaranteed.

Error: 400 Bad request