Skip to content
/Organization API

Verato Organization API (2026.1.2)

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.

Download OpenAPI description
organization.openapi.json
organization.openapi.yaml
Languages
Servers
Mock server
https://developer.verato.com/_mock/apis/organization.openapi
Primary API server (example)
https://api.example.com/provider-link-ws/svc
Relative server path (on-prem / internal routing)
https://developer.verato.com/provider-link-ws/svc

Add an Identity to the LINK stack

Request

Adds a new identity to the LINK database. Returns the resulting LINK identity, linkId, domains, and optional events generated by the operation.

Security
bearerAuth
Bodyapplication/jsonrequired

The web service request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(PostIdentityWsRequest)

Adds a new identity to the LINK database.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/postIdentity \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "identity": {
        "organizationNames": [
          {
            "legalBusinessName": "string",
            "otherOrgName": "string",
            "tradingName": "string",
            "parentOrgName": "string"
          }
        ],
        "addresses": [
          {
            "addressName": "string",
            "addressType": "string",
            "line1": "string",
            "line2": "string",
            "city": "string",
            "district": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string",
            "latitude": "string",
            "longitude": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "contactInformation": [
          {
            "address": {
              "line1": "123 Main St",
              "city": "Springfield",
              "state": "VA",
              "postalCode": "22150"
            },
            "phoneList": [
              {
                "number": "5551234567",
                "type": "WORK",
                "bestTimeToContact": {
                  "day": "MON",
                  "startTime": "09:00",
                  "endTime": "17:00",
                  "allDay": false
                }
              }
            ],
            "bestTimeToContact": {
              "day": "MON",
              "startTime": "09:00",
              "endTime": "17:00",
              "allDay": false
            }
          }
        ],
        "phoneNumbers": [
          {
            "number": "5551234567",
            "type": "WORK",
            "validFrom": "2024-01-01",
            "validTo": "2024-12-31",
            "bestTimeToContact": {
              "day": "MON",
              "startTime": "09:00",
              "endTime": "17:00",
              "allDay": false
            }
          }
        ],
        "faxNumbers": [
          {
            "number": "string",
            "type": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "emails": [
          {
            "email": "string",
            "type": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "alternateIdentifiers": [
          {
            "description": "string",
            "type": "string",
            "value": "string",
            "status": true,
            "issuer": "string",
            "issueDate": "2019-08-24",
            "startDate": "2019-08-24",
            "endDate": "2019-08-24"
          }
        ],
        "externalUniqueIdentifier": [
          {
            "issuer": "string",
            "value": "string",
            "status": "string",
            "startDate": "2019-08-24",
            "endDate": "2019-08-24"
          }
        ],
        "authorizedOfficials": [
          {
            "title": "string",
            "prefix": "string",
            "first": "string",
            "middle": "string",
            "last": "string",
            "suffix": "string",
            "credential": "string",
            "phoneNumber": "string"
          }
        ],
        "employerIdentificationNumber": [
          {
            "value": "string",
            "status": true,
            "issuer": "string",
            "issueDate": "2019-08-24",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "naicsClassifications": [
          {
            "sector": "string",
            "subSector": "string",
            "industryGroup": "string",
            "industry": "string",
            "nationalIndustry": "string"
          }
        ],
        "sicClassifications": [
          {
            "code": "string"
          }
        ],
        "qualifications": [
          {
            "type": "string",
            "qualification": "string",
            "status": "string",
            "issuer": "string",
            "issueDate": "2019-08-24",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "types": [
          {
            "type": "string",
            "subType": "string"
          }
        ],
        "contactOther": [
          {
            "system": "string",
            "type": "string",
            "value": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "product": [
          {
            "name": "string",
            "code": "string",
            "type": "string",
            "category": "string",
            "price": "string",
            "status": "string",
            "description": "string",
            "launchDate": "2019-08-24",
            "market": "string",
            "lineOfBusiness": "string",
            "serviceLines": [
              {
                "serviceLine": "string",
                "subServiceLine": "string"
              }
            ]
          }
        ],
        "numberOfEmployees": [
          {
            "numberOfEmployees": "string"
          }
        ],
        "foundedDate": [
          {
            "foundedDate": "2019-08-24"
          }
        ],
        "annualRevenue": [
          {
            "annualRevenue": "string",
            "year": "string"
          }
        ],
        "legalStatus": [
          {
            "type": "string",
            "source": "string",
            "effectiveDate": "2019-08-24",
            "verificationDate": "2019-08-24",
            "jurisdiction": "string",
            "registrationCountry": "string"
          }
        ]
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    },
    "trackingId": "string"
  }'

Responses

Successful POST identity operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(PostIdentityWsResponse)

PostIdentity service response.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkIdentity": { … },
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … },
    "events": [ … ],
    "incomingIdentity": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Delete a Source

Request

Permanently removes all information and history associated with the given source (source + nativeId) from the LINK database. This also removes any merge/unmerge history associated with that source.

Security
bearerAuth
Bodyapplication/jsonrequired

The web service request containing the source to delete.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(DeleteSourceIdentityWsRequest)

Deletes all information associated with the provided source.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/deleteSourceIdentity \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "source": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful delete source identity operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(DeleteSourceIdentityWsResponse)

Service response for a source-based delete. Indicates which linkIds were modified and which were deleted.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "linkIdsModified": [ … ],
    "linkIdsDeleted": [ … ]
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Search using demographic information

Request

Searches the LINK database using the provided demographic information and returns zero or more candidate identities ordered by match score.

Security
bearerAuth
Bodyapplication/jsonrequired

The demographics search request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(DemographicsSearchWsRequest)

Request object for demographics search.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/demographicsSearch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "AUDIT-123",
    "auditLogMap": {
      "channel": "PORTAL"
    },
    "content": {
      "identity": {
        "organizationNames": [
          {
            "legalBusinessName": "ACME Health"
          }
        ],
        "contactInformation": [
          {
            "address": {
              "line1": "123 Main St",
              "city": "Springfield",
              "state": "VA",
              "postalCode": "22150"
            },
            "phoneList": [
              {
                "number": "5551234567",
                "type": "WORK",
                "bestTimeToContact": {
                  "day": "MON",
                  "startTime": "09:00",
                  "endTime": "17:00",
                  "allDay": false
                }
              }
            ],
            "bestTimeToContact": {
              "day": "MON",
              "startTime": "09:00",
              "endTime": "17:00",
              "allDay": false
            }
          }
        ]
      },
      "matchScoreThreshold": 0.85,
      "maxSearchResults": 10
    },
    "trackingId": "TRACK-123"
  }'

Responses

Successful demographics search operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(DemographicsSearchWsResponse)

Response object for demographics search.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "searchResults": [ … ]
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Query using demographic information

Request

Searches the LINK database using the provided demographic information and returns the best-matching identity view, if found.

Security
bearerAuth
Bodyapplication/jsonrequired

The demographics query request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(DemographicsQueryWsRequest)

Request object for demographics query.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/demographicsQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "identity": {
        "organizationNames": [
          {
            "legalBusinessName": "string",
            "otherOrgName": "string",
            "tradingName": "string",
            "parentOrgName": "string"
          }
        ],
        "addresses": [
          {
            "addressName": "string",
            "addressType": "string",
            "line1": "string",
            "line2": "string",
            "city": "string",
            "district": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string",
            "latitude": "string",
            "longitude": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "contactInformation": [
          {
            "address": {
              "line1": "123 Main St",
              "city": "Springfield",
              "state": "VA",
              "postalCode": "22150"
            },
            "phoneList": [
              {
                "number": "5551234567",
                "type": "WORK",
                "bestTimeToContact": {
                  "day": "MON",
                  "startTime": "09:00",
                  "endTime": "17:00",
                  "allDay": false
                }
              }
            ],
            "bestTimeToContact": {
              "day": "MON",
              "startTime": "09:00",
              "endTime": "17:00",
              "allDay": false
            }
          }
        ],
        "phoneNumbers": [
          {
            "number": "5551234567",
            "type": "WORK",
            "validFrom": "2024-01-01",
            "validTo": "2024-12-31",
            "bestTimeToContact": {
              "day": "MON",
              "startTime": "09:00",
              "endTime": "17:00",
              "allDay": false
            }
          }
        ],
        "faxNumbers": [
          {
            "number": "string",
            "type": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "emails": [
          {
            "email": "string",
            "type": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "alternateIdentifiers": [
          {
            "description": "string",
            "type": "string",
            "value": "string",
            "status": true,
            "issuer": "string",
            "issueDate": "2019-08-24",
            "startDate": "2019-08-24",
            "endDate": "2019-08-24"
          }
        ],
        "externalUniqueIdentifier": [
          {
            "issuer": "string",
            "value": "string",
            "status": "string",
            "startDate": "2019-08-24",
            "endDate": "2019-08-24"
          }
        ],
        "authorizedOfficials": [
          {
            "title": "string",
            "prefix": "string",
            "first": "string",
            "middle": "string",
            "last": "string",
            "suffix": "string",
            "credential": "string",
            "phoneNumber": "string"
          }
        ],
        "employerIdentificationNumber": [
          {
            "value": "string",
            "status": true,
            "issuer": "string",
            "issueDate": "2019-08-24",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "naicsClassifications": [
          {
            "sector": "string",
            "subSector": "string",
            "industryGroup": "string",
            "industry": "string",
            "nationalIndustry": "string"
          }
        ],
        "sicClassifications": [
          {
            "code": "string"
          }
        ],
        "qualifications": [
          {
            "type": "string",
            "qualification": "string",
            "status": "string",
            "issuer": "string",
            "issueDate": "2019-08-24",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "types": [
          {
            "type": "string",
            "subType": "string"
          }
        ],
        "contactOther": [
          {
            "system": "string",
            "type": "string",
            "value": "string",
            "validFrom": "2019-08-24",
            "validTo": "2019-08-24"
          }
        ],
        "product": [
          {
            "name": "string",
            "code": "string",
            "type": "string",
            "category": "string",
            "price": "string",
            "status": "string",
            "description": "string",
            "launchDate": "2019-08-24",
            "market": "string",
            "lineOfBusiness": "string",
            "serviceLines": [
              {
                "serviceLine": "string",
                "subServiceLine": "string"
              }
            ]
          }
        ],
        "numberOfEmployees": [
          {
            "numberOfEmployees": "string"
          }
        ],
        "foundedDate": [
          {
            "foundedDate": "2019-08-24"
          }
        ],
        "annualRevenue": [
          {
            "annualRevenue": "string",
            "year": "string"
          }
        ],
        "legalStatus": [
          {
            "type": "string",
            "source": "string",
            "effectiveDate": "2019-08-24",
            "verificationDate": "2019-08-24",
            "jurisdiction": "string",
            "registrationCountry": "string"
          }
        ]
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    },
    "trackingId": "string"
  }'

Responses

Successful demographics query operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(DemographicsQueryWsResponse)

Response object for demographics query.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Query using native ID

Request

Searches the LINK database for an identity using source + native ID (the customer's source system identifier).

Security
bearerAuth
Bodyapplication/jsonrequired

The native ID query request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(NativeIdQueryWsRequest)

Queries LINK database using source information.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/nativeIdQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "source": {
        "date": "string",
        "name": "string",
        "id": "string"
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    },
    "trackingId": "string"
  }'

Responses

Successful native ID query operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(NativeIdQueryWsResponse)

Service response for a source-based query.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Query using LINK ID

Request

Searches the LINK database for an identity using its LINK ID (Verato golden identifier).

Security
bearerAuth
Bodyapplication/jsonrequired

The identity ID query request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(IdentityIdQueryWsRequest)

Request object used to query by LINK ID.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/identityIdQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "linkId": "string",
      "responseIdentityFormatNames": [
        "string"
      ]
    },
    "trackingId": "string"
  }'

Responses

Successful identity ID query operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(IdentityIdQueryWsResponse)

Response object for query by LINK ID.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "requestedLinkId": "string",
    "customizedIdentities": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Soft delete source from identities

Request

Soft-deletes a source from all entities that contain it. The underlying data is retained for possible restoration but is no longer active in identity views.

Security
bearerAuth
Bodyapplication/jsonrequired

The soft delete source request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(SoftDeleteSourceWsRequest)

Request to soft-delete a source.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/softDeleteSource \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "sourceToSoftDelete": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful soft delete source operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(SoftDeleteSourceWsResponse)

Service response for soft delete.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "linkIdsSoftDeleted": [ … ],
    "linkIdsModified": [ … ]
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Restore source to identities

Request

Restores a previously soft-deleted source in all matching entities, making that source’s data active again.

Security
bearerAuth
Bodyapplication/jsonrequired

The restore source request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject

RestoreSourceWsRequest payload (structure as per internal implementation).

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/restoreSource \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {},
    "trackingId": "string"
  }'

Responses

Successful restore source operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(RestoreSourceWsResponse)

Service response for restoring a source.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "linkIdsModified": [ … ],
    "linkIdCreated": "string"
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Merge two identities

Request

Retires one identity into another by merging data from a retiring source into a surviving source. Returns the surviving linkId and metadata.

Security
bearerAuth
Bodyapplication/jsonrequired

The merge identities request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(MergeIdentitiesWsRequest)

Request to merge (retire) one source identity into another, creating a single surviving identity.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/mergeIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "toSurviveSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      },
      "toRetireSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful merge identities operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(MergeIdentitiesWsResponse)

Response to a merge identities request, returning the surviving LINK ID and surviving source information.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "linkId": "string",
    "toSurviveSource": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Unmerge two identities

Request

Reverses a prior merge by extracting a previously merged identity into its own record. Returns both linkIds and their source information.

Security
bearerAuth
Bodyapplication/jsonrequired

The unmerge identities request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(UnmergeIdentitiesWsRequest)

Request to unmerge data from the retired section of an identity into a new identity.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/unmergeIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "unmergeFromSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      },
      "unmergeSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful unmerge identities operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(UnmergeIdentitiesWsResponse)

Response to unmerge identities request, providing link IDs and source information for the unmerged identities.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "unmergedSource": { … },
    "unmergedFromSource": { … },
    "unmergedId": "string",
    "unmergedFromId": "string"
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Link two identities

Request

Links two identities (typically from different sources) so they are treated as a single entity in the LINK database. Returns the primary linkId.

Security
bearerAuth
Bodyapplication/jsonrequired

The link identities request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(LinkIdentitiesWsRequest)

Represents a request to link data from one identity into another, usually across sources.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/linkIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "linkToSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      },
      "source": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful link identities operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(LinkIdentitiesWsResponse)

Response to link identities request, returning the primary linkId and linkToSource information.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "linkId": "string",
    "linkToSource": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Unlink two identities

Request

Unlinks two previously linked identities, splitting them into separate entities and returning their linkIds and associated source information.

Security
bearerAuth
Bodyapplication/jsonrequired

The unlink identities request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(UnlinkIdentitiesWsRequest)

Request to unlink data from one identity to create a separate identity.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/unlinkIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "unlinkFromSource": {
        "date": "string",
        "name": "string",
        "id": "string"
      },
      "source": {
        "date": "string",
        "name": "string",
        "id": "string"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful unlink identities operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(UnlinkIdentitiesWsResponse)

Response to unlink identities request, providing link IDs and source information for the newly separated identities.

errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "unlinkedId": "string",
    "unlinkedSource": { … },
    "unlinkedFromId": "string",
    "unlinkedFromSource": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Delete a relationship

Request

Deletes a previously defined relationship between two identities.

Security
bearerAuth
Bodyapplication/jsonrequired

The delete relationship request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(DeleteRelationshipWsRequest)
trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/deleteRelationshipService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "id": "string"
    },
    "trackingId": "string"
  }'

Responses

Successful delete relationship operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(DeleteRelationshipWsResponse)
errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "id": "string"
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Add a new relationship

Request

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

Security
bearerAuth
Bodyapplication/jsonrequired

The add relationship request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(AddRelationshipWsRequest)
trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/addRelationshipService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "relationship": {
        "id": "string",
        "relationshipVerb": "string",
        "inverseRelationshipVerb": "string",
        "subjectVeratoId": "string",
        "objectVeratoId": "string",
        "domain": "string",
        "trustFactor": "string",
        "details": {
          "property1": null,
          "property2": null
        },
        "status": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful add relationship operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(AddRelationshipWsResponse)
errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "relationship": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Update an existing relationship

Request

Updates an existing relationship (search and update) based on the provided relationship payload.

Security
bearerAuth
Bodyapplication/json

The search/update relationship request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(UpdateRelationshipWsRequest)
trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/searchRelationshipsService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "relationship": {
        "id": "string",
        "relationshipVerb": "string",
        "inverseRelationshipVerb": "string",
        "subjectVeratoId": "string",
        "objectVeratoId": "string",
        "domain": "string",
        "trustFactor": "string",
        "details": {
          "property1": null,
          "property2": null
        },
        "status": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z"
      }
    },
    "trackingId": "string"
  }'

Responses

Successful search/update relationship operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(UpdateRelationshipWsResponse)
errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "relationship": { … }
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}

Query notifications

Request

Searches notifications for a given customer over a specified time window, with paging support.

Security
bearerAuth
Bodyapplication/jsonrequired

The notification search request.

auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

auditLogMapobject(Map_string_string)

Generic map of string keys to string values.

contentobject(SearchNotificationsWsRequest)

Query notifications for the customer.

trackingIdstring
curl -i -X POST \
  https://developer.verato.com/_mock/apis/organization.openapi/searchNotifications \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "content": {
      "pageNumber": 0,
      "pageSize": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z"
    },
    "trackingId": "string"
  }'

Responses

Successful search notifications operation.

Bodyapplication/json
auditIdstring(AuditID)

Audit identifier used for tracing and governance across Verato services.

successboolean
unparsedJsonstring
warningsArray of strings
retryableErrorboolean
messagestring
contentobject(SearchNotificationsWsResponse)
errorsArray of strings
trackingIdstring
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "content": {
    "customerId": "string",
    "hasNext": true,
    "notifications": [ … ],
    "totalElements": 0
  },
  "errors": [
    "string"
  ],
  "trackingId": "string"
}