# 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)

## Other

### Add an Identity (postIdentity)

 - [POST /postIdentity](https://developer.verato.com/apis/provider.openapi/paths/~1postidentity/post.md): Adds a new identity into Verato. The posted identity may represent a Practitioner (Type 1) or Health Facility (Type 2).

### Search using demographic information (demographicsSearch)

 - [POST /demographicsSearch](https://developer.verato.com/apis/provider.openapi/paths/~1demographicssearch/post.md): Searches Verato using the provided demographic and provider attributes. It returns zero or more candidate identities ordered by match score.

### Query using demographic information (demographicsQuery)

 - [POST /demographicsQuery](https://developer.verato.com/apis/provider.openapi/paths/~1demographicsquery/post.md): Searches Verato using the provided demographic information and returns the best-matching identity if found.

### Query using link ID (identityIdQuery)

 - [POST /identityIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1identityidquery/post.md): Search for an Identity with supplied linkId

### Query using native ID (nativeIdQuery)

 - [POST /nativeIdQuery](https://developer.verato.com/apis/provider.openapi/paths/~1nativeidquery/post.md): Searches Verato for an identity using source name + native ID (the customer's source system identifier).

### Hard Delete a Source (deleteSourceIdentity)

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

### Restore a soft-deleted source (restoreSource)

 - [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.

### Soft delete a source from identities (softDeleteSource)

 - [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.

### Link two identities (linkIdentities)

 - [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 link ID. Note: only provider identities of the same type can be linked together (ie Practitioner to Practitioner, not Practitioner and Health Facility).

### Merge two identities (mergeIdentities)

 - [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. Note: only provider identities of the same type can be merged together (ie Practitioner to Practitioner, not Practitioner and Health Facility).

### Query notifications (searchNotifications)

 - [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.

### Unlink two identities (unlinkIdentities)

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

### Unmerge two identities (unmergeIdentities)

 - [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 link ID and the linkId it was unmerged from.

### Add a new relationship (addRelationshipService)

 - [POST /addRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1addrelationshipservice/post.md): Adds a relationship between two identities according to configured
relationship definitions.

### Searches for relationships (searchRelationshipsService)

 - [POST /searchRelationshipsService](https://developer.verato.com/apis/provider.openapi/paths/~1searchrelationshipsservice/post.md): Searches for relationships

### Delete a relationship (deleteRelationshipService)

 - [POST /deleteRelationshipService](https://developer.verato.com/apis/provider.openapi/paths/~1deleterelationshipservice/post.md): Deletes a previously defined relationship between two identities.