Verato SearchNotifications API

openapi: 3.0.3
info:
  title: Verato Organization AddRelationshipService SearchNotifications API
  version: 2026.1.2
  description: 'The Verato Organization API provides comprehensive identity management capabilities for organizations within the Verato LINK platform. This API enables you to:


    - **Ingest and manage organization identities**: Add, update, and delete organization records with rich demographic and contact information.

    - **Search and query**: Find organizations using demographic data, native IDs, or link IDs (Verato''s golden identifier).

    - **Lifecycle management**: Soft-delete and restore organization records while preserving data history.

    - **Merge and link operations**: Consolidate duplicate organizations, manage master data relationships, and maintain data lineage.

    - **Relationship management**: Define and query relationships between organizations (parent-child, affiliations, etc.).

    - **Notifications**: Track and audit identity changes and events across your organization data.


    All operations follow a standard request/response envelope pattern with audit tracking, error handling, and optional response format customization.

    '
servers:
- url: https://yourveratodomain.com/org-link-ws/svc
  description: Production Organization Link API
- url: https://yourveratodomain.com/org-link-ws/svc
  description: Sandbox Organization Link API
security:
- basicAuth: []
tags:
- name: SearchNotifications
paths:
  /searchNotifications:
    post:
      summary: Query notifications (searchNotifications)
      description: 'Retrieves identity-related notifications for a specific period of time, such as merge events, link/unlink events, or other configured notifications.

        '
      operationId: searchNotifications
      requestBody:
        required: true
        description: The notification search request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_searchNotifications'
      responses:
        '200':
          description: Successful search notifications operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_searchNotifications'
      tags:
      - SearchNotifications
components:
  schemas:
    NotificationLowerCaseBody:
      type: object
      properties:
        survivingSource:
          type: string
        retiredSource:
          type: string
        previousLinkId:
          type: string
        survivingNativeId:
          type: string
        newLinkId:
          type: string
        source:
          type: string
        nativeId:
          type: string
        retiredNativeId:
          type: string
    ServiceResponse_searchNotifications:
      type: object
      properties:
        auditId:
          type: string
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
        retryableError:
          type: boolean
        message:
          type: string
        content:
          $ref: '#/components/schemas/SearchNotificationsWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    SearchNotificationsWsResponse:
      type: object
      properties:
        customerId:
          type: string
          description: Name of the customer for the notifications.
        hasNext:
          type: boolean
          description: Indicates whether more notifications are available.
        notifications:
          type: array
          description: Notifications retrieved.
          items:
            $ref: '#/components/schemas/NotificationData'
        totalElements:
          type: integer
          format: int64
          description: Number of notifications retrieved.
    SearchNotificationsWsRequest:
      type: object
      description: Query notifications for the customer.
      required:
      - pageNumber
      - pageSize
      - startDate
      - endDate
      properties:
        pageNumber:
          type: integer
          format: int32
          description: Page number.
        pageSize:
          type: integer
          format: int32
          description: Page size.
        startDate:
          type: string
          format: date-time
          description: Start date.
        endDate:
          type: string
          format: date-time
          description: End date.
    NotificationData:
      type: object
      properties:
        partitionKey:
          type: string
        service:
          type: string
        customerId:
          type: string
        notificationLowerCaseBody:
          $ref: '#/components/schemas/NotificationLowerCaseBody'
        notificationType:
          type: string
        body:
          type: string
        ts:
          type: string
          format: date-time
        username:
          type: string
    ServiceRequest_searchNotifications:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/SearchNotificationsWsRequest'
        trackingId:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic