addRelationshipService

An important component of Person Data Management is the ability to understand and define how two person identities are related to one another.

With Verato, a user can create direct relationships between Person entities (mapped from LinkID to LinkID). Verato supplies pre-defined relationship types, sometimes referred to as “verbs”, to define the relationship that exists between two entities. Examples may include is parent of or is caregiver for. Customers can work with Verato customer support representatives to define additional relationship types on an as-needed basis. Relationship domains–for example PERSON–are a way to group common relationship types together.

The addRelationshipService can be used to create a new relationship between Person entities. The service relies on a valid domain, relationship type (or “verb”), and two target LinkIDs to define the relationship between.

Sample URL

The URL for this request follows the format: https://custXXXX.verato-connect.com/link-ws/svc/addRelationship/Service , where XXXX is your 4‑digit customer identifier.

addRelationshipService JSON request

Note
Input values for startDate & endDate have to be specified in one the following formats:

• yyyy-MM-dd'T'HH:mm:ss.SSSX
• yyyy-MM-dd'T'HH:mm:ss.SSS
• EEE, dd MMM yyyy HH:mm:ss zzz
• yyyy-MM-dd

• The request requires:
  • A trackingId for audit and traceability
  • A relationship object containing:
    • domain — currently only "Person" is supported on link-ws
    • subjectVeratoId — the Verato LinkID of the identity initiating the relationship
    • objectVeratoId — the Verato LinkID of the identity receiving the relationship
    • relationshipVerb — the verb defining the relationship direction (e.g., is parent of)
    • startDate and endDate — optional relationship validity dates
    • status — either "active" or "inactive"
    • trustFactor — optional confidence indicator (if supported in your environment)

• {
    "trackingId": "string",
    "content": {
      "relationship": {
        "domain": "Person",
        "objectVeratoId": "692f01d9000b0a5e089dff44",
        "relationshipVerb": "is parent of",
        "subjectVeratoId": "692f01d9000b0a5e089dff45",
        "trustFactor": "string",
        "startDate": "2021-10-15",
        "endDate": "2025-10-15",
        "status": "active"
      }
    }
  }

addRelationshipService JSON response

• The response includes:
  • An echo of the same tracking ID from the request
  • A success flag indicating whether the relationship was created
  • A message describing the outcome
  • A content object containing:
    • The created relationship record, including:
      • The subject and object Verato IDs
      • The relationship verb and its inverse
      • The domain and entity types
      • Any provided metadata (dates, status, trust factor)
  • An auditId for traceability
  • A retryableError flag indicating whether the request can be retried

• {
    "success": true,
    "message": "RelationshipCreated",
    "content": {
      "relationship": {
        "domain": "Person",
        "subjectVeratoId": "692f01d9000b0a5e089dff45",
        "objectVeratoId": "692f01d9000b0a5e089dff44",
        "relationshipVerb": "is parent of",
        "inverseVerb": "is child of",
        "startDate": "2021-10-15",
        "endDate": "2025-10-15",
        "status": "active"
      }
    },
    "trackingId": "string",
    "auditId": "c3b2e1d4-7f9a-4bcd-9aef-123456789abc",
    "retryableError": false
  }