Verato UnlinkIdentities API

openapi: 3.2.0
info:
  title: Verato Organization AddRelationshipService Unlink Identities 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: UnlinkIdentities
paths:
  /unlinkIdentities:
    post:
      summary: Unlink two identities (unlinkIdentities)
      description: 'Unlinks two previously linked identities, splitting them into separate

        entities and returning their linkIds and associated source information.

        '
      operationId: unlinkIdentities
      requestBody:
        required: true
        description: The unlink identities request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_unlinkIdentities'
      responses:
        '200':
          description: Successful unlink identities operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_unlinkIdentities'
      tags:
      - UnlinkIdentities
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.
    UnlinkIdentitiesWsRequest:
      type: object
      description: 'Request to unlink data from one identity to create a separate identity.

        '
      required:
      - unlinkFromSource
      - source
      properties:
        unlinkFromSource:
          description: Source info targeting the identity to unlink from.
          $ref: '#/components/schemas/Source'
        source:
          description: Source representing the identity that will be unlinked.
          $ref: '#/components/schemas/Source'
    ServiceRequest_unlinkIdentities:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/UnlinkIdentitiesWsRequest'
        trackingId:
          type: string
    ServiceResponse_unlinkIdentities:
      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/UnlinkIdentitiesWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    UnlinkIdentitiesWsResponse:
      type: object
      description: 'Response to unlink identities request, providing link IDs and source

        information for the newly separated identities.

        '
      required:
      - unlinkedId
      - unlinkedFromId
      - unlinkedSource
      - unlinkedFromSource
      properties:
        unlinkedId:
          type: string
          description: link ID of the identity that was unlinked.
        unlinkedSource:
          description: Source info of the identity that was unlinked.
          $ref: '#/components/schemas/Source'
        unlinkedFromId:
          type: string
          description: link ID of the identity unlinked from.
        unlinkedFromSource:
          description: Source info for the identity unlinked from.
          $ref: '#/components/schemas/Source'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic