Verato DeleteRelationshipService API

The DeleteRelationshipService API from Verato — 1 operation(s) for deleterelationshipservice.

OpenAPI Specification

verato-deleterelationshipservice-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Verato Organization AddRelationshipService DeleteRelationshipService 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: DeleteRelationshipService
paths:
  /deleteRelationshipService:
    post:
      summary: Delete a relationship (deleteRelationshipService)
      description: 'Deletes a previously defined relationship between two identities.

        '
      operationId: deleteRelationship
      requestBody:
        required: true
        description: The delete relationship request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_deleteRelationshipService'
      responses:
        '200':
          description: Successful delete relationship operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_deleteRelationshipService'
      tags:
      - DeleteRelationshipService
components:
  schemas:
    ServiceResponse_deleteRelationshipService:
      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/DeleteRelationshipWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    ServiceRequest_deleteRelationshipService:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/DeleteRelationshipWsRequest'
        trackingId:
          type: string
    DeleteRelationshipWsRequest:
      type: object
      properties:
        id:
          type: string
    DeleteRelationshipWsResponse:
      type: object
      properties:
        id:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic