Verato AddRelationshipService API

openapi: 3.0.3
info:
  title: Verato Organization AddRelationshipService 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: AddRelationshipService
paths:
  /addRelationshipService:
    post:
      summary: Add a new relationship (addRelationshipService)
      description: 'Adds a relationship between two identities according to configured

        relationship definitions.

        '
      operationId: addRelationship
      requestBody:
        required: true
        description: The add relationship request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_addRelationshipService'
      responses:
        '200':
          description: Successful add relationship operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_addRelationshipService'
      tags:
      - AddRelationshipService
components:
  schemas:
    Map_string_Object:
      type: object
      additionalProperties: {}
      description: Generic map of string keys to arbitrary values.
    RelationshipWs:
      type: object
      description: Relationship between two identities.
      properties:
        id:
          type: string
        relationshipVerb:
          type: string
        inverseRelationshipVerb:
          type: string
        subjectVeratoId:
          type: string
        objectVeratoId:
          type: string
        domain:
          type: string
        trustFactor:
          type: string
        details:
          $ref: '#/components/schemas/Map_string_Object'
        status:
          type: string
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
    ServiceRequest_addRelationshipService:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/AddRelationshipWsRequest'
        trackingId:
          type: string
    AddRelationshipWsRequest:
      type: object
      properties:
        relationship:
          $ref: '#/components/schemas/NewRelationshipRequest'
    NewRelationshipRequest:
      type: object
      description: Public fields required to create a new relationship between two identities.
      properties:
        id:
          type: string
        relationshipVerb:
          type: string
        subjectVeratoId:
          type: string
        objectVeratoId:
          type: string
        domain:
          type: string
        status:
          type: string
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
    ServiceResponse_addRelationshipService:
      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/AddRelationshipWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    AddRelationshipWsResponse:
      type: object
      properties:
        relationship:
          $ref: '#/components/schemas/RelationshipWs'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic