Verato UnlinkIdentities API

openapi: 3.2.0
info:
  title: Verato Unlink Identities API
  version: 2026.1.2
  description: 'Operations tagged UnlinkIdentities across 2 of this provider''s published API definitions: verato-organization-openapi.yml, verato-person-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://yourveratodomain.com/org-link-ws/svc
  description: Production Organization Link API
- url: https://yourveratodomain.com/link-ws/svc
  description: Production 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
    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
components:
  schemas:
    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'
    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.
    ServiceRequest_unlinkIdentities:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/UnlinkIdentitiesWsRequest'
        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'
    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
    UnlinkIdentitiesWsRequest_2:
      type: object
      required:
      - unlinkFromSource
      - source
      properties:
        unlinkFromSource:
          $ref: '#/components/schemas/Source_2'
          description: Return the source info that targets the Identity from which we will unlink the source Identity
        source:
          $ref: '#/components/schemas/Source_2'
          description: Represents the Identity that will be unlinked
      description: a request by a customer to unlink ( extract) data from one Identity to create another
    Source_2:
      type: object
      properties:
        date:
          type: string
          description: The date of the source data in ISO format (yyyy-mm-dd).
        name:
          type: string
          description: The name of the data source.  Must be unique across Verato.
        id:
          type: string
          description: The ID of an identity within the given data source.
      description: Represents the information tracking an identity to a source that contains the identity
    UnlinkIdentitiesWsResponse_2:
      type: object
      properties:
        unlinkedId:
          type: string
          description: Link ID of the Identity that was unlinked
        unlinkedSource:
          $ref: '#/components/schemas/Source_2'
          description: The source information of identity that was unlinked
        unlinkedFromId:
          type: string
          description: Link ID of Identity unlinked from.
        unlinkedFromSource:
          $ref: '#/components/schemas/Source_2'
          description: The source information for unlinked from Identity
      required:
      - unlinkedId
      - unlinkedFromId
      - unlinkedSource
      - unlinkedFromSource
      description: When two identities have been linked by the LinkIdentities WebService, unlink them by extracting the previously linked Identity into its own record.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- verato-organization-openapi.yml
- verato-person-openapi.yml