# Verato Person API Version: 2026.1.2 ## Servers Production Link API ``` https://yourveratodomain.com/link-ws/svc ``` Sandbox Link API ``` https://yourveratodomain.com/link-ws/svc ``` ## Security ### basicAuth Type: http Scheme: basic ## Download OpenAPI description [Verato Person API](https://verato-developer-portal-dev.redocly.app/_bundle/apis/person.openapi.yaml) ## Other ### Add an Identity (postIdentity) - [POST /v2/postIdentity](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_v2_postidentity.md): Adds a new identity into Verato. ### Search using demographic information (demographicsSearch) - [POST /v2/demographicsSearch](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_v2_demographicssearch.md): Searches Verato using the provided demographic attributes. It returns zero or more candidate identities ordered by match score. ### Query using demographic information (demographicsQuery) - [POST /v2/demographicsQuery](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_v2_demographicsquery.md): Searches Verato using the provided demographic information and returns the best-matching identity if found. ### Query using link ID (identityIdQuery) - [POST /v2/identityIdQuery](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_v2_identityidquery.md): Search for an Identity with supplied linkId ### Query using native ID (nativeIdQuery) - [POST /v2/nativeIdQuery](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_v2_nativeidquery.md): Searches Verato for an identity using source name + native ID (the customer's source system identifier). ### Create Data Sources (createDataSource) - [POST /createDataSource](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_createdatasource.md): 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. Source name constraints: maximum 255 characters, no spaces, and the following characters are not supported: " | : '. Source names are case-sensitive; Verato recommends a consistent capitalization standard (all uppercase or all lowercase) to avoid duplicate records. Failed additions are reported individually in the response and do not prevent other sources in the same request from being created. Common failure causes include the source already existing or the name matching a reserved Verato source code (e.g. "Verato"). ### Hard Delete a Source (deleteSourceIdentity) - [POST /deleteSourceIdentity](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_deletesourceidentity.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. ### Reactivate source from identities (reactivateSourceWs) - [POST /reactivateSourceWs](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_reactivatesourcews.md): Used to reactivate a source record from your instance of Universal Identity, that was previously deactivated. ### Deactivate source from identities (deactivateSourceWs) - [POST /deactivateSourceWs](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_deactivatesourcews.md): Used to deactivate (logically delete) a source record from your instance of Universal Identity. ### Query for Household (householdQuery) - [POST /householdQuery](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_householdquery.md): Used to retrieve the collection of Link IDs that have been grouped into a household. ### Link two identities (linkIdentities) - [POST /linkIdentities](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_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/person.openapi/other/post_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/person.openapi/other/post_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/person.openapi/other/post_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/person.openapi/other/post_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/person.openapi/other/post_addrelationshipservice.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/person.openapi/other/post_searchrelationshipsservice.md): Searches for relationships ### Delete a relationship (deleteRelationshipService) - [POST /deleteRelationshipService](https://verato-developer-portal-dev.redocly.app/apis/person.openapi/other/post_deleterelationshipservice.md): Deletes a previously defined relationship between two identities.