Verato SoftDeleteSource API

openapi: 3.0.3
info:
  title: Verato Organization AddRelationshipService SoftDeleteSource 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: SoftDeleteSource
paths:
  /softDeleteSource:
    post:
      summary: Soft delete a source from identities (softDeleteSource)
      description: 'Soft deletes a source from all identities that reference it. The source and its data are marked as deleted but can be restored later. Merge and linkage history is preserved for audit.

        '
      operationId: softDeleteSource
      requestBody:
        required: true
        description: The soft delete source request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_softDeleteSource'
      responses:
        '200':
          description: Successful soft delete source operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_softDeleteSource'
      tags:
      - SoftDeleteSource
components:
  schemas:
    Source:
      type: object
      description: Tracks an identity to a particular source system and record ID.
      properties:
        date:
          type: string
          description: The date of the source data in ISO format (yyyy-MM-dd).
        name:
          type: string
          description: Name of the data source. Must be unique across Verato.
        id:
          type: string
          description: ID of an identity within the given data source.
    SoftDeleteSourceWsRequest:
      type: object
      description: Request to soft-delete a source.
      required:
      - sourceToSoftDelete
      properties:
        sourceToSoftDelete:
          description: Source to soft-delete.
          $ref: '#/components/schemas/Source'
    ServiceRequest_softDeleteSource:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/SoftDeleteSourceWsRequest'
        trackingId:
          type: string
    SoftDeleteSourceWsResponse:
      type: object
      description: Service response for soft delete.
      required:
      - linkIdsModified
      - linkIdsSoftDeleted
      properties:
        linkIdsSoftDeleted:
          type: array
          description: Entity IDs that were fully soft-deleted.
          items:
            type: string
        linkIdsModified:
          type: array
          description: Entity IDs that were modified.
          items:
            type: string
    ServiceResponse_softDeleteSource:
      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/SoftDeleteSourceWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic