---
title: "Add a new relationship (addRelationshipService)"
method: POST
path: "/addRelationshipService"
---

# Add a new relationship (addRelationshipService)

`POST /addRelationshipService`

Adds a relationship between two identities according to configured
relationship definitions.

## Request body

- ServiceRequestAddRelationshipService — Standard wrapper for all service requests.
  - `trackingId` string — Optional client-defined correlation ID.
  - `content` AddRelationshipWsRequest
    - `relationship` NewRelationshipRequest — Public fields required to create a new relationship between two Verato entities.
      - `id` string
      - `relationshipVerb` string
      - `subjectVeratoId` string
      - `objectVeratoId` string
      - `domain` string
      - `status` string
      - `startDate` string, date-time
      - `endDate` string, date-time

## Response `200`

Add relationship response

- ServiceResponseAddRelationshipService — Standard wrapper for all service responses.
  - `auditId` string — Unique audit identifier for correlating requests and responses.
  - `success` boolean — Indicates whether the business operation succeeded.
  - `warnings` string[] — Non-fatal warnings generated by the operation.
  - `retryableError` boolean — Indicates whether an error is transient and the request may be retried.
  - `message` string — Human-readable status message.
  - `errors` string[] — Error messages if success is false.
  - `trackingId` string — Echo of the request trackingId, if provided.
  - `content` AddRelationshipWsResponse
    - `relationship` RelationshipWs — Relationship between two Verato entities.
      - `id` string
      - `relationshipVerb` string
      - `inverseRelationshipVerb` string
      - `subjectVeratoId` string
      - `objectVeratoId` string
      - `domain` string
      - `status` string
      - `trustFactor` string
      - `startDate` string, date-time
      - `endDate` string, date-time
      - `details` ObjectMap — Map of string keys to arbitrary JSON values.

---

[API](https://skmtc.net/verato/apis/verato-provider-api.md) · [All operations](https://skmtc.net/verato/apis/verato-provider-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verato/verato-provider-api/versions/adc923264a6f/schema)