# 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

Production Organization Link API
```
https://yourveratodomain.com/org-link-ws/svc
```

Sandbox Organization Link API
```
https://yourveratodomain.com/org-link-ws/svc
```

## Security

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[Verato Organization API](https://verato-developer-portal-dev.redocly.app/_bundle/apis/organization.openapi.yaml)

## Other

### Add an Identity (postIdentity)

 - [POST /postIdentity](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/postidentity.md): Adds a new identity into Verato.

### Search using demographic information (demographicsSearch)

 - [POST /demographicsSearch](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/demographicssearch.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/demographicsquery.md): Searches Verato using the provided demographic information and returns the best-matching identity if found.

### Query using link ID (identityIdQuery)

 - [POST /identityIdQuery](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/identityidquery.md): Search for an Identity with supplied linkId

### Query using native ID (nativeIdQuery)

 - [POST /nativeIdQuery](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/nativeidquery.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/deletesourceidentity.md): Permanently removes all information and history associated with the given
source (source name + nativeId) from Verato. This also removes any
merge/unmerge history associated with that source.

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

 - [POST /restoreSource](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/restoresource.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/softdeletesource.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/linkidentities.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 person, and they should be represented as a single link ID.

### Merge two identities (mergeIdentities)

 - [POST /mergeIdentities](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/mergeidentities.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.

### Query notifications (searchNotifications)

 - [POST /searchNotifications](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/searchnotifications.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/unlinkidentities.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/unmergeidentities.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://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/addrelationship.md): Adds a relationship between two identities according to configured
relationship definitions.

### Searches for relationships (searchRelationshipsService)

 - [POST /searchRelationshipsService](https://verato-developer-portal-dev.redocly.app/apis/organization.openapi/other/searchrelationships.md): Searches for relationships

### Delete a relationship (deleteRelationshipService)

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