Verato MergeIdentities API

openapi: 3.2.0
info:
  title: Verato Merge Identities API
  version: 2026.1.2
  description: 'Operations tagged MergeIdentities 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: MergeIdentities
paths:
  /mergeIdentities:
    post:
      summary: Merge two identities (mergeIdentities)
      description: Merges a "toRetire" source identity into a "toSurvive" source identity. After a merge, the retired source is marked as merged and the surviving identity contains combined data. The response returns the surviving linkId.
      operationId: mergeIdentities
      requestBody:
        required: true
        description: The merge identities request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_mergeIdentities'
      responses:
        '200':
          description: Successful merge identities operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_mergeIdentities'
      tags:
      - MergeIdentities
    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:
    MergeIdentitiesWsResponse:
      type: object
      description: 'Response to a merge identities request, returning the surviving link ID

        and surviving source information.

        '
      properties:
        linkId:
          type: string
          description: link ID of the surviving identity.
        toSurviveSource:
          description: Original source information for the surviving identity.
          $ref: '#/components/schemas/Source'
    ServiceResponse_mergeIdentities:
      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/MergeIdentitiesWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    MergeIdentitiesWsRequest:
      type: object
      description: 'Request to merge (retire) one source identity into another, creating a

        single surviving identity.

        '
      required:
      - toRetireSource
      - toSurviveSource
      properties:
        toSurviveSource:
          description: Source representing the identity that will survive.
          $ref: '#/components/schemas/Source'
        toRetireSource:
          description: Source representing the identity that will be retired.
          $ref: '#/components/schemas/Source'
    ServiceRequest_mergeIdentities:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/MergeIdentitiesWsRequest'
        trackingId:
          type: string
    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.
    MergeIdentitiesWsResponse_2:
      type: object
      properties:
        linkId:
          type: string
          description: Return the link ID of the Identity that received merged/retired data during a MergeIdentity request
        toSurviveSource:
          $ref: '#/components/schemas/Source_2'
          description: Return the original source information for the Identity that was the toSurvive Identity. If the merge fails, this will be null
      description: When two identities have been merged by the MergeIdentities WebService , return the link ID of the primary Identity
    MergeIdentitiesWsRequest_2:
      type: object
      properties:
        toSurviveSource:
          $ref: '#/components/schemas/Source_2'
          description: Source represents the source/nativeId of the Identity that will survive
        toRetireSource:
          $ref: '#/components/schemas/Source_2'
          description: Source represents the source/nativeId of the Identity that will get retired/merged
      required:
      - toRetireSource
      - toSurviveSource
      description: Request by a customer to (merge/retire) data from one Source into 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
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- verato-organization-openapi.yml
- verato-person-openapi.yml