# Verato Organization API

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.


Version: 2026.1.2

## Servers

Primary API server (example)
```
https://api.example.com/provider-link-ws/svc
```

Relative server path (on-prem / internal routing)
```
/provider-link-ws/svc
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[Verato Organization API](https://developer.verato.com/_bundle/apis/organization.openapi.yaml)

## Other

### Add an Identity to the LINK stack

 - [POST /postIdentity](https://developer.verato.com/apis/organization.openapi/other/postidentity.md): Adds a new identity to the LINK database. Returns the resulting LINK
identity, linkId, domains, and optional events generated by the operation.

### Delete a Source

 - [POST /deleteSourceIdentity](https://developer.verato.com/apis/organization.openapi/other/deletesourceidentity.md): 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.

### Search using demographic information

 - [POST /demographicsSearch](https://developer.verato.com/apis/organization.openapi/other/demographicssearch.md): Searches the LINK database using the provided demographic information and
returns zero or more candidate identities ordered by match score.

### Query using demographic information

 - [POST /demographicsQuery](https://developer.verato.com/apis/organization.openapi/other/demographicsquery.md): Searches the LINK database using the provided demographic information and
returns the best-matching identity view, if found.

### Query using native ID

 - [POST /nativeIdQuery](https://developer.verato.com/apis/organization.openapi/other/nativeidquery.md): Searches the LINK database for an identity using source + native ID
(the customer's source system identifier).

### Query using LINK ID

 - [POST /identityIdQuery](https://developer.verato.com/apis/organization.openapi/other/identityidquery.md): Searches the LINK database for an identity using its LINK ID
(Verato golden identifier).

### Soft delete source from identities

 - [POST /softDeleteSource](https://developer.verato.com/apis/organization.openapi/other/softdeletesource.md): 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.

### Restore source to identities

 - [POST /restoreSource](https://developer.verato.com/apis/organization.openapi/other/restoresource.md): Restores a previously soft-deleted source in all matching entities, making
that source’s data active again.

### Merge two identities

 - [POST /mergeIdentities](https://developer.verato.com/apis/organization.openapi/other/mergeidentities.md): Retires one identity into another by merging data from a retiring source
into a surviving source. Returns the surviving linkId and metadata.

### Unmerge two identities

 - [POST /unmergeIdentities](https://developer.verato.com/apis/organization.openapi/other/unmergeidentities.md): Reverses a prior merge by extracting a previously merged identity into
its own record. Returns both linkIds and their source information.

### Link two identities

 - [POST /linkIdentities](https://developer.verato.com/apis/organization.openapi/other/linkidentities.md): Links two identities (typically from different sources) so they are treated
as a single entity in the LINK database. Returns the primary linkId.

### Unlink two identities

 - [POST /unlinkIdentities](https://developer.verato.com/apis/organization.openapi/other/unlinkidentities.md): Unlinks two previously linked identities, splitting them into separate
entities and returning their linkIds and associated source information.

### Delete a relationship

 - [POST /deleteRelationshipService](https://developer.verato.com/apis/organization.openapi/other/deleterelationship.md): Deletes a previously defined relationship between two identities.

### Add a new relationship

 - [POST /addRelationshipService](https://developer.verato.com/apis/organization.openapi/other/addrelationship.md): Adds a relationship between two identities according to configured
relationship definitions.

### Update an existing relationship

 - [POST /searchRelationshipsService](https://developer.verato.com/apis/organization.openapi/other/searchrelationships.md): Updates an existing relationship (search and update) based on the
provided relationship payload.

### Query notifications

 - [POST /searchNotifications](https://developer.verato.com/apis/organization.openapi/other/searchnotifications.md): Searches notifications for a given customer over a specified time window,
with paging support.