{"items":[{"type":"link","fsPath":"index.page.tsx","metadata":{},"label":"Home","link":"/","routeSlug":"/"},{"type":"group","fsPath":"docs/quickstart/intro.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/quickstart/intro","routeSlug":"/docs/quickstart/intro","items":[{"type":"link","fsPath":"docs/quickstart/sso.md","metadata":{"type":"markdown"},"label":"Get Started with SSO","link":"/docs/quickstart/sso","routeSlug":"/docs/quickstart/sso"},{"type":"link","fsPath":"docs/quickstart/enrich.md","metadata":{"type":"markdown"},"label":"Verato Enrich for MDM Cloud","link":"/quickstart/enrich","routeSlug":"/quickstart/enrich"}]},{"type":"group","fsPath":"docs/guides/intro.md","metadata":{"type":"markdown"},"label":"Use Case Guides","link":"/docs/guides/intro","routeSlug":"/docs/guides/intro","items":[{"type":"link","fsPath":"docs/guides/id-crosswalk.page.md","metadata":{"type":"markdown"},"label":"Creating and Using ID Crosswalks","link":"/docs/guides/id-crosswalk.page","routeSlug":"/docs/guides/id-crosswalk.page"},{"type":"link","fsPath":"docs/guides/maintaining-golden-record.page.md","metadata":{"type":"markdown"},"label":"Maintaining a Golden Record","link":"/docs/guides/maintaining-golden-record.page","routeSlug":"/docs/guides/maintaining-golden-record.page"},{"type":"link","fsPath":"docs/guides/identity-search.page.md","metadata":{"type":"markdown"},"label":"End-User Identity Search","link":"/docs/guides/identity-search.page","routeSlug":"/docs/guides/identity-search.page"},{"type":"link","fsPath":"docs/guides/automating-identity-search.page.md","metadata":{"type":"markdown"},"label":"Automating Identity Search","link":"/docs/guides/automating-identity-search.page","routeSlug":"/docs/guides/automating-identity-search.page"},{"type":"link","fsPath":"docs/guides/tracking-original-source-system-metadata.page.md","metadata":{"type":"markdown"},"label":"Tracking Original Source System Metadata","link":"/docs/guides/tracking-original-source-system-metadata.page","routeSlug":"/docs/guides/tracking-original-source-system-metadata.page"}]},{"type":"group","fsPath":"docs/tutorials/tutorials.index.md","metadata":{"type":"markdown"},"label":"Tutorials","link":"/docs/tutorials/tutorials.index","routeSlug":"/docs/tutorials/tutorials.index","items":[{"type":"link","fsPath":"docs/tutorials/api-connectivity.page.md","metadata":{"type":"markdown"},"label":"Using Postman with Verato APIs","link":"/docs/tutorials/api-connectivity.page","routeSlug":"/docs/tutorials/api-connectivity.page"},{"type":"link","fsPath":"docs/tutorials/using-curl.page.md","metadata":{"type":"markdown"},"label":"Using cURL","link":"/docs/tutorials/using-curl.page","routeSlug":"/docs/tutorials/using-curl.page"},{"type":"link","fsPath":"docs/tutorials/batch-processing.page.md","metadata":{"type":"markdown"},"label":"Batch Processing","link":"/docs/tutorials/batch-processing.page","routeSlug":"/docs/tutorials/batch-processing.page"}]},{"type":"group","fsPath":"docs/reference/intro.md","metadata":{"type":"markdown"},"label":"API Reference","link":"/docs/reference/intro","routeSlug":"/docs/reference/intro","items":[{"type":"group","fsPath":"apis/person.openapi.yaml","link":"/apis/person.openapi","routeSlug":"/apis/person.openapi","label":"Person API","items":[{"label":"Add an Identity (postIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_v2_postidentity","routeSlug":"/apis/person.openapi/other/post_v2_postidentity","metadata":{"seo":{"title":"Add an Identity (postIdentity)","description":"Adds or updates an identity record in the Person entity — the Source + Native ID in the request determines whether the call creates a new identity or updates an existing one, and every response returns the assigned Link ID. This is the primary ingestion endpoint used to synchronize source-system adds/updates into Verato."}},"httpPath":"/v2/postIdentity"},{"label":"Search using demographic information (demographicsSearch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_v2_demographicssearch","routeSlug":"/apis/person.openapi/other/post_v2_demographicssearch","metadata":{"seo":{"title":"Search using demographic information (demographicsSearch)","description":"Performs a fuzzy search across the Person entity for identities that are potential matches to a set of demographic attributes, returning one-to-many ranked results with match scores rather than a single best match. Use this when you want candidate identities for a person rather than one definitive record."}},"httpPath":"/v2/demographicsSearch"},{"label":"Query using demographic information (demographicsQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_v2_demographicsquery","routeSlug":"/apis/person.openapi/other/post_v2_demographicsquery","metadata":{"seo":{"title":"Query using demographic information (demographicsQuery)","description":"Retrieves the single best-matching identity in the Person entity for a set of demographic attributes, returning a match only if it scores at or above the same threshold used during postIdentity matching. Use this when you need one definitive identity rather than a list of candidates."}},"httpPath":"/v2/demographicsQuery"},{"label":"Query using link ID (identityIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_v2_identityidquery","routeSlug":"/apis/person.openapi/other/post_v2_identityidquery","metadata":{"seo":{"title":"Query using link ID (identityIdQuery)","description":"Queries the Person entity for an identity using its Verato Link ID. This is the primary way to retrieve an identity when you already have the Link ID from a previous operation."}},"httpPath":"/v2/identityIdQuery"},{"label":"Query using native ID (nativeIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_v2_nativeidquery","routeSlug":"/apis/person.openapi/other/post_v2_nativeidquery","metadata":{"seo":{"title":"Query using native ID (nativeIdQuery)","description":"Retrieves the single identity in the Person entity that contains the given Source + Native ID. Use this when you have a source system's own record identifier and need to look up the corresponding Verato identity."}},"httpPath":"/v2/nativeIdQuery"},{"label":"Create Data Sources (createDataSource)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_createdatasource","routeSlug":"/apis/person.openapi/other/post_createdatasource","metadata":{"seo":{"title":"Create Data Sources (createDataSource)","description":"Creates one or more new data sources in the Universal Identity platform. Up to 10 data sources can be created per call. Newly added sources may take 10–15 minutes to become available. This service only adds data sources — it does not delete or modify existing ones."}},"httpPath":"/createDataSource"},{"label":"Hard Delete a Source (deleteSourceIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_deletesourceidentity","routeSlug":"/apis/person.openapi/other/post_deletesourceidentity","metadata":{"seo":{"title":"Hard Delete a Source (deleteSourceIdentity)","description":"Physically deletes a source record from the Person entity to keep Verato in sync when a record is deleted from a source system. If it's the only source record in an identity, the whole identity is deleted; otherwise the identity survives with its Link ID unchanged and just the deleted source's data removed."}},"httpPath":"/deleteSourceIdentity"},{"label":"Reactivate source from identities (reactivateSourceWs)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_reactivatesourcews","routeSlug":"/apis/person.openapi/other/post_reactivatesourcews","metadata":{"seo":{"title":"Reactivate source from identities (reactivateSourceWs)","description":"Reactivates a source record in the Person entity that was previously deactivated, restoring it to its original Link ID. Use this to reverse a deactivateSourceWs call."}},"httpPath":"/reactivateSourceWs"},{"label":"Deactivate source from identities (deactivateSourceWs)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_deactivatesourcews","routeSlug":"/apis/person.openapi/other/post_deactivatesourcews","metadata":{"seo":{"title":"Deactivate source from identities (deactivateSourceWs)","description":"Logically deletes (deactivates) a source record in the Person entity so it's excluded from future matching while remaining visible in the UI and API responses. Deactivated records can later be restored with reactivateSourceWs."}},"httpPath":"/deactivateSourceWs"},{"label":"Query for Household (householdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_householdquery","routeSlug":"/apis/person.openapi/other/post_householdquery","metadata":{"seo":{"title":"Query for Household (householdQuery)","description":"Retrieves the set of Link IDs grouped into a household, looked up by Link ID, Source + Native ID, or Household ID. Households group multiple Person entities based on shared core or extended attributes; this is a Verato Consumer Identity-licensed capability."}},"httpPath":"/householdQuery"},{"label":"Link two identities (linkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_linkidentities","routeSlug":"/apis/person.openapi/other/post_linkidentities","metadata":{"seo":{"title":"Link two identities (linkIdentities)","description":"Forces two identity records (by Source + Native ID) into the same Link ID even though their demographic data wasn't similar enough to match automatically. Use this on an exception basis when you have external evidence that two records are the same person."}},"httpPath":"/linkIdentities"},{"label":"Merge two identities (mergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_mergeidentities","routeSlug":"/apis/person.openapi/other/post_mergeidentities","metadata":{"seo":{"title":"Merge two identities (mergeIdentities)","description":"Merges a \"toRetire\" source record into a \"toSurvive\" source record, forcing them into the same Link ID and marking the retired source as merged/inactive. After a merge, the retired source's attribute data is hidden from the surviving identity but can still be retrieved via nativeIdQuery."}},"httpPath":"/mergeIdentities"},{"label":"Query notifications (searchNotifications)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_searchnotifications","routeSlug":"/apis/person.openapi/other/post_searchnotifications","metadata":{"seo":{"title":"Query notifications (searchNotifications)","description":"Retrieves a paginated feed of notification messages describing identity-changing events (matches, links, merges, deactivations, overlays, etc.) that occurred in the Person entity within a specified date range. Verato recommends every implementation poll this endpoint to keep source systems synchronized with identity changes."}},"httpPath":"/searchNotifications"},{"label":"Unlink two identities (unlinkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_unlinkidentities","routeSlug":"/apis/person.openapi/other/post_unlinkidentities","metadata":{"seo":{"title":"Unlink two identities (unlinkIdentities)","description":"Forces apart two identity records that had been matched or linked into the same Link ID, splitting one out into its own new Link ID. Use this to reverse a linkIdentities call or to split records that were incorrectly matched together."}},"httpPath":"/unlinkIdentities"},{"label":"Unmerge two identities (unmergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_unmergeidentities","routeSlug":"/apis/person.openapi/other/post_unmergeidentities","metadata":{"seo":{"title":"Unmerge two identities (unmergeIdentities)","description":"Reactivates a previously merged/retired source record and splits it out of its current Link ID into a new one of its own. Use this only to reverse a mergeIdentities call made in error."}},"httpPath":"/unmergeIdentities"},{"label":"Add a new relationship (addRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_addrelationshipservice","routeSlug":"/apis/person.openapi/other/post_addrelationshipservice","metadata":{"seo":{"title":"Add a new relationship (addRelationshipService)","description":"Creates a direct relationship (e.g., \"is parent of\") between two Person entities, identified by their Link IDs, with optional start and end dates and a status. Use this to model family or guardianship connections between identities in Verato."}},"httpPath":"/addRelationshipService"},{"label":"Searches for relationships (searchRelationshipsService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_searchrelationshipsservice","routeSlug":"/apis/person.openapi/other/post_searchrelationshipsservice","metadata":{"seo":{"title":"Searches for relationships (searchRelationshipsService)","description":"Searches for existing relationships between Person entities, filterable by subject Link ID, object Link ID, or relationship verb. Use this to look up how a given identity is connected to others (e.g., all relationships where it is the subject)."}},"httpPath":"/searchRelationshipsService"},{"label":"Delete a relationship (deleteRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/person.openapi/other/post_deleterelationshipservice","routeSlug":"/apis/person.openapi/other/post_deleterelationshipservice","metadata":{"seo":{"title":"Delete a relationship (deleteRelationshipService)","description":"Deletes an existing relationship between two Person entities that was previously created with addRelationshipService. There is no legacy Patient Journey equivalent — this endpoint is new to the platform."}},"httpPath":"/deleteRelationshipService"}],"metadata":{"type":"openapi","title":"Verato Person API","version":"2026.1.2"}},{"type":"group","fsPath":"apis/organization.openapi.yaml","link":"/apis/organization.openapi","routeSlug":"/apis/organization.openapi","label":"Organization API","items":[{"label":"Add an Identity (postIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/postidentity","routeSlug":"/apis/organization.openapi/other/postidentity","metadata":{"seo":{"title":"Add an Identity (postIdentity)","description":"Adds or updates a record in the Organization entity. Each record is uniquely identified by Source and Native ID; the response returns the Link ID assigned to the record — either a new Link ID or an existing one if the posted record matched a previously-posted record."}},"httpPath":"/postIdentity"},{"label":"Search using demographic information (demographicsSearch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/demographicssearch","routeSlug":"/apis/organization.openapi/other/demographicssearch","metadata":{"seo":{"title":"Search using demographic information (demographicsSearch)","description":"Returns one-to-many candidate identities from the Organization entity that have any degree of similarity to the demographic search criteria provided — a fuzzy search useful when you aren't sure which (or whether any) existing identity matches, rather than expecting a single confirmed match."}},"httpPath":"/demographicsSearch"},{"label":"Query using demographic information (demographicsQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/demographicsquery","routeSlug":"/apis/organization.openapi/other/demographicsquery","metadata":{"seo":{"title":"Query using demographic information (demographicsQuery)","description":"Retrieves the single best-matching identity from the Organization entity for the demographic data supplied in the request, using Verato's referential matching algorithm. A match is only returned if it scores at or above the same threshold used for automatic matching during postIdentity — use this when you expect exactly one confirmed match rather than a candidate list."}},"httpPath":"/demographicsQuery"},{"label":"Query using link ID (identityIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/identityidquery","routeSlug":"/apis/organization.openapi/other/identityidquery","metadata":{"seo":{"title":"Query using link ID (identityIdQuery)","description":"Retrieves a single identity from the Organization 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."}},"httpPath":"/identityIdQuery"},{"label":"Query using native ID (nativeIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/nativeidquery","routeSlug":"/apis/organization.openapi/other/nativeidquery","metadata":{"seo":{"title":"Query using native ID (nativeIdQuery)","description":"Retrieves a single identity from the Organization 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 yet have its Link ID."}},"httpPath":"/nativeIdQuery"},{"label":"Hard Delete a Source (deleteSourceIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/deletesourceidentity","routeSlug":"/apis/organization.openapi/other/deletesourceidentity","metadata":{"seo":{"title":"Hard Delete a Source (deleteSourceIdentity)","description":"Physically deletes one of your source records from the Organization 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, the whole entity is deleted; if other sources remain, the entity survives with the same Link ID and only the deleted source's data is removed."}},"httpPath":"/deleteSourceIdentity"},{"label":"Restore a soft-deleted source (restoreSource)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/restoresource","routeSlug":"/apis/organization.openapi/other/restoresource","metadata":{"seo":{"title":"Restore a soft-deleted source (restoreSource)","description":"Restores a previously soft-deleted source across all Organization entities where it was present, reversing a prior softDeleteSource call. Depending on the current state of the graph, this may reactivate an existing entity or create a new one. This is a new capability — Organization is a new entity with no legacy predecessor."}},"httpPath":"/restoreSource"},{"label":"Soft delete a source from identities (softDeleteSource)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/softdeletesource","routeSlug":"/apis/organization.openapi/other/softdeletesource","metadata":{"seo":{"title":"Soft delete a source from identities (softDeleteSource)","description":"Logically deletes (soft-deletes) a source from every Organization entity that references it, so its data is excluded from future matching and identity views while being retained for possible restoration via restoreSource. This is a new capability — Organization is a new entity with no legacy predecessor."}},"httpPath":"/softDeleteSource"},{"label":"Link two identities (linkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/linkidentities","routeSlug":"/apis/organization.openapi/other/linkidentities","metadata":{"seo":{"title":"Link two identities (linkIdentities)","description":"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 though the demographic data wasn't similar enough to match automatically."}},"httpPath":"/linkIdentities"},{"label":"Merge two identities (mergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/mergeidentities","routeSlug":"/apis/organization.openapi/other/mergeidentities","metadata":{"seo":{"title":"Merge two identities (mergeIdentities)","description":"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 Organization entity. The retired source's data is hidden from the resulting entity's demographics but the record remains retrievable via nativeIdQuery."}},"httpPath":"/mergeIdentities"},{"label":"Query notifications (searchNotifications)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/searchnotifications","routeSlug":"/apis/organization.openapi/other/searchnotifications","metadata":{"seo":{"title":"Query notifications (searchNotifications)","description":"Retrieves queued notification messages describing Link ID assignment changes (triggered by postIdentity, linkIdentities, unlinkIdentities, mergeIdentities, unmergeIdentities, and deleteSourceIdentity) within a specified date/time range, using page-based pagination. Verato recommends every implementation include a searchNotifications integration to keep source systems synchronized with identity changes."}},"httpPath":"/searchNotifications"},{"label":"Unlink two identities (unlinkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/unlinkidentities","routeSlug":"/apis/organization.openapi/other/unlinkidentities","metadata":{"seo":{"title":"Unlink two identities (unlinkIdentities)","description":"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 apart records that were incorrectly matched together."}},"httpPath":"/unlinkIdentities"},{"label":"Unmerge two identities (unmergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/unmergeidentities","routeSlug":"/apis/organization.openapi/other/unmergeidentities","metadata":{"seo":{"title":"Unmerge two identities (unmergeIdentities)","description":"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 currently in a retired/merged state."}},"httpPath":"/unmergeIdentities"},{"label":"Add a new relationship (addRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/addrelationship","routeSlug":"/apis/organization.openapi/other/addrelationship","metadata":{"seo":{"title":"Add a new relationship (addRelationshipService)","description":"Adds a relationship between two entities — for example, an organization and another organization, or an organization and a facility — according to a configured relationship verb (e.g., is a subsidiary of, is affiliated with) and the Link IDs of the entities being connected."}},"httpPath":"/addRelationshipService"},{"label":"Searches for relationships (searchRelationshipsService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/searchrelationships","routeSlug":"/apis/organization.openapi/other/searchrelationships","metadata":{"seo":{"title":"Searches for relationships (searchRelationshipsService)","description":"Searches for — and can update — existing relationships involving an Organization entity, using optional filters such as subject Link ID, object Link ID, or relationship verb. Use this to look up which relationships already exist, or to modify attributes or status on an existing relationship."}},"httpPath":"/searchRelationshipsService"},{"label":"Delete a relationship (deleteRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organization.openapi/other/deleterelationship","routeSlug":"/apis/organization.openapi/other/deleterelationship","metadata":{"seo":{"title":"Delete a relationship (deleteRelationshipService)","description":"Deletes a previously defined relationship between two entities. There is no legacy predecessor for the Organization entity — this endpoint, like the entity itself, is new to the platform."}},"httpPath":"/deleteRelationshipService"}],"metadata":{"type":"openapi","title":"Verato Organization API","version":"2026.1.2","description":"The Verato Organization API provides comprehensive identity management capabilities for organizations within the Verato LINK platform. This API enables you to:\n\n- **Ingest and manage organization identities**: Add, update, and delete organization records with rich demographic and contact information.\n- **Search and query**: Find organizations using demographic data, native IDs, or link IDs (Verato's golden identifier).\n- **Lifecycle management**: Soft-delete and restore organization records while preserving data history.\n- **Merge and link operations**: Consolidate duplicate organizations, manage master data relationships, and maintain data lineage.\n- **Relationship management**: Define and query relationships between organizations (parent-child, affiliations, etc.).\n- **Notifications**: Track and audit identity changes and events across your organization data.\n\nAll operations follow a standard request/response envelope pattern with audit tracking, error handling, and optional response format customization.\n"}},{"type":"group","fsPath":"apis/provider.openapi.yaml","link":"/apis/provider.openapi","routeSlug":"/apis/provider.openapi","label":"Provider API","items":[{"label":"Add an Identity (postIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1postidentity/post","routeSlug":"/apis/provider.openapi/paths/~1postidentity/post","metadata":{"seo":{"title":"Add an Identity (postIdentity)","description":"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); the response returns the Link ID assigned to the record — either a new Link ID or an existing one if the record matched a previously-posted record."}},"httpPath":"/postIdentity"},{"label":"Search using demographic information (demographicsSearch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1demographicssearch/post","routeSlug":"/apis/provider.openapi/paths/~1demographicssearch/post","metadata":{"seo":{"title":"Search using demographic information (demographicsSearch)","description":"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 whether any) existing identity matches, rather than expecting a single confirmed match."}},"httpPath":"/demographicsSearch"},{"label":"Query using demographic information (demographicsQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1demographicsquery/post","routeSlug":"/apis/provider.openapi/paths/~1demographicsquery/post","metadata":{"seo":{"title":"Query using demographic information (demographicsQuery)","description":"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 scores at or above the same threshold used for automatic matching during postIdentity — use this when you expect exactly one confirmed match rather than a candidate list."}},"httpPath":"/demographicsQuery"},{"label":"Query using link ID (identityIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1identityidquery/post","routeSlug":"/apis/provider.openapi/paths/~1identityidquery/post","metadata":{"seo":{"title":"Query using link ID (identityIdQuery)","description":"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."}},"httpPath":"/identityIdQuery"},{"label":"Query using native ID (nativeIdQuery)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1nativeidquery/post","routeSlug":"/apis/provider.openapi/paths/~1nativeidquery/post","metadata":{"seo":{"title":"Query using native ID (nativeIdQuery)","description":"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 yet have its Link ID."}},"httpPath":"/nativeIdQuery"},{"label":"Hard Delete a Source (deleteSourceIdentity)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1deletesourceidentity/post","routeSlug":"/apis/provider.openapi/paths/~1deletesourceidentity/post","metadata":{"seo":{"title":"Hard Delete a Source (deleteSourceIdentity)","description":"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, the whole entity is deleted; if other sources remain, the entity survives with the same Link ID and only the deleted source's data is removed."}},"httpPath":"/deleteSourceIdentity"},{"label":"Restore a soft-deleted source (restoreSource)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1restoresource/post","routeSlug":"/apis/provider.openapi/paths/~1restoresource/post","metadata":{"seo":{"title":"Restore a soft-deleted source (restoreSource)","description":"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 an existing entity or create a new one. There is no legacy Provider Data Management equivalent — this is a new capability on the platform."}},"httpPath":"/restoreSource"},{"label":"Soft delete a source from identities (softDeleteSource)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1softdeletesource/post","routeSlug":"/apis/provider.openapi/paths/~1softdeletesource/post","metadata":{"seo":{"title":"Soft delete a source from identities (softDeleteSource)","description":"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 via restoreSource. There is no legacy Provider Data Management equivalent — this is a new capability on the platform."}},"httpPath":"/softDeleteSource"},{"label":"Link two identities (linkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1linkidentities/post","routeSlug":"/apis/provider.openapi/paths/~1linkidentities/post","metadata":{"seo":{"title":"Link two identities (linkIdentities)","description":"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 though the demographic data wasn't similar enough to match automatically."}},"httpPath":"/linkIdentities"},{"label":"Merge two identities (mergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1mergeidentities/post","routeSlug":"/apis/provider.openapi/paths/~1mergeidentities/post","metadata":{"seo":{"title":"Merge two identities (mergeIdentities)","description":"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 retired source's data is hidden from the resulting entity's demographics but the record remains retrievable via nativeIdQuery."}},"httpPath":"/mergeIdentities"},{"label":"Query notifications (searchNotifications)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1searchnotifications/post","routeSlug":"/apis/provider.openapi/paths/~1searchnotifications/post","metadata":{"seo":{"title":"Query notifications (searchNotifications)","description":"Retrieves queued notification messages describing Link ID assignment changes (triggered by postIdentity, linkIdentities, unlinkIdentities, mergeIdentities, unmergeIdentities, and deleteSourceIdentity) within a specified date/time range, using page-based pagination. Verato recommends every implementation include a searchNotifications integration to keep source systems synchronized with identity changes."}},"httpPath":"/searchNotifications"},{"label":"Unlink two identities (unlinkIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1unlinkidentities/post","routeSlug":"/apis/provider.openapi/paths/~1unlinkidentities/post","metadata":{"seo":{"title":"Unlink two identities (unlinkIdentities)","description":"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 apart records that were incorrectly matched together."}},"httpPath":"/unlinkIdentities"},{"label":"Unmerge two identities (unmergeIdentities)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1unmergeidentities/post","routeSlug":"/apis/provider.openapi/paths/~1unmergeidentities/post","metadata":{"seo":{"title":"Unmerge two identities (unmergeIdentities)","description":"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 currently in a retired/merged state."}},"httpPath":"/unmergeIdentities"},{"label":"Add a new relationship (addRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1addrelationshipservice/post","routeSlug":"/apis/provider.openapi/paths/~1addrelationshipservice/post","metadata":{"seo":{"title":"Add a new relationship (addRelationshipService)","description":"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, is affiliated with) and the Link IDs of the entities being connected."}},"httpPath":"/addRelationshipService"},{"label":"Searches for relationships (searchRelationshipsService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1searchrelationshipsservice/post","routeSlug":"/apis/provider.openapi/paths/~1searchrelationshipsservice/post","metadata":{"seo":{"title":"Searches for relationships (searchRelationshipsService)","description":"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 relationships already exist, or to modify attributes or status on an existing relationship."}},"httpPath":"/searchRelationshipsService"},{"label":"Delete a relationship (deleteRelationshipService)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider.openapi/paths/~1deleterelationshipservice/post","routeSlug":"/apis/provider.openapi/paths/~1deleterelationshipservice/post","metadata":{"seo":{"title":"Delete a relationship (deleteRelationshipService)","description":"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 remove a relationship previously created with addRelationshipService."}},"httpPath":"/deleteRelationshipService"}],"metadata":{"type":"openapi","title":"Verato Provider API","version":"2026.1.2","description":"Verato Provider Link services for managing provider identities (Practitioner Type 1, Health Facility Type 2, and Organizations), including:\n  - Creating and updating master identities\n  - Searching and querying by demographics, source/native IDs, and link IDs\n  - Managing source lifecycle (soft delete, restore, hard delete)\n  - Managing merge, unmerge, link, unlink workflows\n  - Managing graph relationships between Verato entities\n  - Retrieving identity-related notifications\n"}}]},{"type":"group","label":"Data Dictionary","items":[{"type":"group","fsPath":"docs/data-dictionary/intro.page.md","metadata":{"type":"markdown"},"label":"MDM Cloud Platform Data Model (API)","link":"/docs/data-dictionary/intro.page","routeSlug":"/docs/data-dictionary/intro.page","items":[{"type":"group","label":"Person","items":[{"type":"link","fsPath":"docs/data-dictionary/person/core-person.md","metadata":{"type":"markdown"},"label":"Core Person Data Model","link":"/docs/data-dictionary/person/core-person","routeSlug":"/docs/data-dictionary/person/core-person"},{"type":"link","fsPath":"docs/data-dictionary/person/patient.md","metadata":{"type":"markdown"},"label":"Patient Data Model","link":"/docs/data-dictionary/person/patient","routeSlug":"/docs/data-dictionary/person/patient"}]},{"type":"group","label":"Organization","items":[{"type":"link","fsPath":"docs/data-dictionary/organization/core-organization.md","metadata":{"type":"markdown"},"label":"Core Organization Data Model","link":"/docs/data-dictionary/organization/core-organization","routeSlug":"/docs/data-dictionary/organization/core-organization"}]},{"type":"group","label":"Provider","items":[{"type":"link","fsPath":"docs/data-dictionary/provider/practitioner.md","metadata":{"type":"markdown"},"label":"Practitioner (Type-1) Data Model","link":"/docs/data-dictionary/provider/practitioner","routeSlug":"/docs/data-dictionary/provider/practitioner"},{"type":"link","fsPath":"docs/data-dictionary/provider/health-facility.md","metadata":{"type":"markdown"},"label":"Health Facility (Type-2) Data Model","link":"/docs/data-dictionary/provider/health-facility","routeSlug":"/docs/data-dictionary/provider/health-facility"}]}]},{"type":"link","fsPath":"docs/data-dictionary/snowflake-data-share.md","metadata":{"type":"markdown"},"label":"Snowflake Data Share","link":"/docs/data-dictionary/snowflake-data-share","routeSlug":"/docs/data-dictionary/snowflake-data-share"},{"type":"link","fsPath":"docs/data-dictionary/analytics-insights.md","metadata":{"type":"markdown"},"label":"Analytics & Insights (Reporting)","link":"/docs/data-dictionary/analytics-insights","routeSlug":"/docs/data-dictionary/analytics-insights"}]}]}