# Verato Provider API

Verato Provider Link services for managing provider identities (Practitioner Type 1, Health Facility Type 2, and Organizations), including:
  - Creating and updating master identities
  - Searching and querying by demographics, source/native IDs, and link IDs
  - Managing source lifecycle (soft delete, restore, hard delete)
  - Managing merge, unmerge, link, unlink workflows
  - Managing graph relationships between Verato entities
  - Retrieving identity-related notifications


Version: 2026.1.2

## Servers

Production Provider Link API
```
https://yourveratodomain.com/provider-link-ws/svc
```

Sandbox Provider Link API
```
https://yourveratodomain.com/provider-link-ws/svc
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

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

## Other

### Add an Identity to the LINK stack

 - [POST /postIdentity](https://developer.verato.com/apis/provider.openapi/paths/~1postidentity/post.md): Adds a new provider identity into Verato. The posted identity may represent a Practitioner (Type 1), Health Facility (Type 2), or Organization. The service returns the resolved LINK identity, including linkId and domains, along with optional grouped-by-source and custom views.

### Search using demographic information

 - [POST /demographicsSearch](https://developer.verato.com/apis/provider.openapi/paths/~1demographicssearch/post.md): Performs a multi-match search across Verato using demographic and provider attributes. Returns a ranked list of candidate matches with match scores and same-identity indicators.

### Query using demographic information

 - [POST /demographicsQuery](https://developer.verato.com/apis/provider.openapi/paths/~1demographicsquery/post.md): Performs a best-match query for a single identity using demographic and provider attributes. Returns the resolved identity, linkId, and domains, optionally with grouped-by-source and custom views.

### Query using native ID

 - [POST /nativeIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1nativeidquery/post.md): Queries Verato for an identity using a source + nativeId pair. Use this when you know the source system identifier and want to retrieve the Verato LINK identity.

### Query using LINK ID

 - [POST /identityIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1identityidquery/post.md): Queries Verato for an identity using the Verato LINK ID. This is the primary way to retrieve an identity when you already have the linkId from a previous operation.

### Hard delete a source identity

 - [POST /deleteSourceIdentity](https://developer.verato.com/apis/provider.openapi/paths/~1deletesourceidentity/post.md): Permanently removes all information and history associated with a specific source + nativeId across Verato. This also removes merge/unmerge history associated with that source identity. Use with caution.

### Soft delete a source from identities

 - [POST /softDeleteSource](https://developer.verato.com/apis/provider.openapi/paths/~1softdeletesource/post.md): Soft deletes a source from all identities that reference it. The source and its data are marked as deleted but can be restored later. Merge and linkage history is preserved for audit.

### Restore a soft-deleted source

 - [POST /restoreSource](https://developer.verato.com/apis/provider.openapi/paths/~1restoresource/post.md): Restores a previously soft-deleted source across all identities where it was present. A new entity may be created or existing entities modified depending on the current state of the graph.

### Merge two identities

 - [POST /mergeIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1mergeidentities/post.md): Merges a "toRetire" source identity into a "toSurvive" source identity. After a merge, the retired source is marked as merged and the surviving identity contains combined data. The response returns the surviving linkId.

### Unmerge two identities

 - [POST /unmergeIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1unmergeidentities/post.md): Reverses a previous merge operation by extracting a previously merged source identity into its own record. Returns the new linkId and the linkId it was unmerged from.

### Link two identities

 - [POST /linkIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1linkidentities/post.md): Links two existing identities together without retiring either source. This is typically used when you determine that two separate source identities belong to the same real-world provider, and they should be represented as a single Verato identity cluster.

### Unlink two identities

 - [POST /unlinkIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1unlinkidentities/post.md): Splits two previously linked identities into separate identity clusters. The operation uses the provided source information to determine which source identity should be extracted into a new linkId.

### Add a new relationship

 - [POST /addRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1addrelationshipservice/post.md): Adds a new relationship between two Verato entities (e.g., practitioner to facility, facility to organization) according to the configured relationship definitions and verbs.

### Delete a relationship

 - [POST /deleteRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1deleterelationshipservice/post.md): Deletes an existing relationship between two entities. The relationship is identified by its relationship ID.

### Update/search an existing relationship

 - [POST /searchRelationshipsService](https://developer.verato.com/apis/provider.openapi/paths/~1searchrelationshipsservice/post.md): Searches for and/or updates an existing relationship. Typically used to modify attributes or status on a relationship between two entities.

### Query notifications

 - [POST /searchNotifications](https://developer.verato.com/apis/provider.openapi/paths/~1searchnotifications/post.md): Retrieves identity-related notifications for a specific period of time, such as merge events, link/unlink events, or other configured notifications. Results are paginated by pageNumber and pageSize.

