# 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

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

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

 - [POST /postIdentity](https://developer.verato.com/apis/provider.openapi/paths/~1postidentity/post.md): Adds or updates a record in the Provider entity. Each record is uniquely identified by Source, Native ID, and Entity Type Code (Type 1 for an individual practitioner, Type 2 for a health facility); th
 - [POST /demographicsSearch](https://developer.verato.com/apis/provider.openapi/paths/~1demographicssearch/post.md): Returns one-to-many candidate identities from the Provider entity that have any degree of similarity to the demographic search criteria provided — a fuzzy search useful when you aren't sure which (or
 - [POST /demographicsQuery](https://developer.verato.com/apis/provider.openapi/paths/~1demographicsquery/post.md): Retrieves the single best-matching identity from the Provider entity for the demographic data supplied in the request, using Verato's referential matching algorithm. A match is only returned if it sco
 - [POST /identityIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1identityidquery/post.md): Retrieves a single identity from the Provider entity using its Verato Link ID. This is the primary way to fetch a full identity record when you already have the Link ID from a prior operation.
 - [POST /nativeIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1nativeidquery/post.md): Retrieves a single identity from the Provider entity using the Source + Native ID of a previously-posted source record. Use this when you know which source-system record you're looking for but don't y
 - [POST /deleteSourceIdentity](https://developer.verato.com/apis/provider.openapi/paths/~1deletesourceidentity/post.md): Physically deletes one of your source records from the Provider entity to keep it in sync when a record is deleted from your source system. If the deleted source record is the entity's only source, th
 - [POST /restoreSource](https://developer.verato.com/apis/provider.openapi/paths/~1restoresource/post.md): Restores a previously soft-deleted source across all Provider entities where it was present, reversing a prior softDeleteSource call. Depending on the current state of the graph, this may reactivate a
 - [POST /softDeleteSource](https://developer.verato.com/apis/provider.openapi/paths/~1softdeletesource/post.md): Logically deletes (soft-deletes) a source from every Provider entity that references it, so its data is excluded from future matching and identity views while being retained for possible restoration v
 - [POST /linkIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1linkidentities/post.md): Forces two source records (each identified by Source + Native ID) into a single common Link ID — used on an exception basis when you have external evidence that two records are the same identity even
 - [POST /mergeIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1mergeidentities/post.md): Forces two source records into a common Link ID and converts one of them into a retired/merged state — used to sync a merge that already happened in your source system into the Provider entity. The re
 - [POST /searchNotifications](https://developer.verato.com/apis/provider.openapi/paths/~1searchnotifications/post.md): Retrieves queued notification messages describing Link ID assignment changes (triggered by postIdentity, linkIdentities, unlinkIdentities, mergeIdentities, unmergeIdentities, and deleteSourceIdentity)
 - [POST /unlinkIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1unlinkidentities/post.md): Forces apart two source records that had previously been matched or linked into the same Link ID, splitting one record out into its own new Link ID. Used to reverse a linkIdentities call or to split a
 - [POST /unmergeIdentities](https://developer.verato.com/apis/provider.openapi/paths/~1unmergeidentities/post.md): Re-activates a previously-merged/retired source record and splits it back out into its own new Link ID, reversing the outcome of a mergeIdentities call. Only succeeds if the target source record is cu
 - [POST /addRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1addrelationshipservice/post.md): Creates a relationship between two Verato entities — for example, linking a practitioner to a facility, or a facility to an organization — using a configured relationship verb (e.g., is employed by, i
 - [POST /searchRelationshipsService](https://developer.verato.com/apis/provider.openapi/paths/~1searchrelationshipsservice/post.md): Searches for — and can update — existing relationships involving a Provider entity, using optional filters such as subject Link ID, object Link ID, or relationship verb. Use this to look up which rela
 - [POST /deleteRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1deleterelationshipservice/post.md): Deletes an existing relationship between two entities, identified by its relationship ID. There is no legacy Provider Data Management equivalent — this endpoint is new to the platform. Use it to remov