find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/verato-addrelationshipservice-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Verato Add Relationship Service API
  version: 2026.1.2
  description: 'Operations tagged AddRelationshipService 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: 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
    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:
    ServiceRequest_addRelationshipService:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/AddRelationshipWsRequest'
        trackingId:
          type: string
    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
    Map_string_Object:
      type: object
      additionalProperties: {}
      description: Generic map of string keys to arbitrary values.
    AddRelationshipWsRequest:
      type: object
      properties:
        relationship:
          $ref: '#/components/schemas/NewRelationshipRequest'
    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
    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
    AddRelationshipWsResponse:
      type: object
      properties:
        relationship:
          $ref: '#/components/schemas/RelationshipWs'
    RelationshipWs_2:
      type: object
      properties:
        relationshipVerb:
          type: string
        endDate:
          type: string
          format: date-time
        objectVeratoId:
          type: string
        domain:
          type: string
        inverseRelationshipVerb:
          type: string
        subjectVeratoId:
          type: string
        trustFactor:
          type: string
        details:
          type: object
          additionalProperties: {}
        id:
          type: string
        startDate:
          type: string
          format: date-time
        status:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- verato-organization-openapi.yml
- verato-person-openapi.yml