Patient Journey Web Service API Reference Guide

In the first version of Patient Journey APIs, some attributes (specifically SSN, DOB, Email, Gender) are returned as simple strings as part of an array like in the API response below. These clusters do not include clusterStatus as part of the first vers...

The postIdentity web service adds or updates your customer records into Universal Identity. The Source + Native ID present on the Post Identity interaction dictates whether you are updating a customer record that was previously posted to Universal Ident...

The demographicsSearch web service is intended to retrieve one or more identities from Universal Identity that are potential matches to the search input criteria. Unlike the demographicsQuery web service (which returns only the single best-matching Univ...

This web service retrieves the single matching identity from Universal Identity that matches the demographic data provided in the web service request. The match determination is made using Verato’s referential matching algorithm, and a matching identity...

The identityIdQuery service retrieves a single matching identity from Universal Identity based on the Link ID for the identity.Like the postIdentity web service, the query web services allow the client to provide a “tracking ID” string that is client-ge...

The nativeIdQuery web service retrieves the single matching identity from Universal Identity that contains the Source+Native ID provided in the web service request. Like the postIdentity web service, the query web services allow the client-generated tra...

sourceRecordsQueryThe sourceRecordsQuery web service retrieves the matching identity objects from Universal Identity that contain the one or more Source+Native IDs provided in the web service request while optionally limiting what clusters are returned....

linkIdLookupBySourceRecordsThe linkIdLookupBySourceRecords web service accepts a list of Source + Native ID (S+N) and returns a list of all Link IDs that contains any of those S+N records along with its associated records and source metadata.This helps ...

The searchTasksWs web service is used to retrieve tasks linked with a Source+Native ID record, as provided in the web service request. Note By default, the web service returns tasks from the last 30 days. To retrieve tasks from a broader date-time range...

If you have large volumes of data sources and frequent additions to your list of data sources, you can use the createDataSource web service to create a new, valid data source in the Universal Identity platform. Newly added data source may take about 10...

The deleteSourceIdentity web service is used to physically delete one of your source records from your instance of Universal Identity. When source records are added or updated in your various source applications/databases, you use the postIdentity servi...

The reactivateSourceWs web service is used to reactivate a source record from your instance of Universal Identity, that was previously deactivated. NoteReactivating a record assigns the record to its original Link ID.Sample URLThe URL for this request i...

The deactivateSourceWs web service is used to deactivate (logically delete) a source record from your instance of Universal Identity. NoteWith each deactivateSourceWs request, we now automatically assess whether all records associated with the identity...

"Householding" describes the grouping of multiple Link IDs based on similarities in their core and/or extended attributes. The householdQuery web service is used to retrieve the collection of Link IDs that have been grouped into a household. By default,...

The linkIdentities web service is used to force two customer source records (each identified by its Source + Native ID) to be linked together in a common Link ID. NoteWith each linkIdentities request, we now automatically assess whether all records ass...

The mergeIdentities web service is used to force two customer source records (each identified by its Source + Native ID) to be linked together in a common Link ID and convert one of the customer source records into a retired/merged state. NoteWith each...

The searchNotifications web service is used to retrieve notification messages from Universal Identity within a specified time range. Notification messages are continually queued in Universal Identity, and you can choose how frequently they want to use t...

The unlinkIdentities web service is used to force apart two customer source records (each identified by its Source + Native ID) that had been matched into the same Link ID. This service can be used to do one of the following:  Reverse the outcome of a ...

The unmergeIdentities web service is used to re-activate a previously-merged source record and force it apart from its current Link ID. NoteThis service can only be used to reverse the outcome of a mergeIdentities operation. The unmergeIdentities operat...

The getRelationshipDefinitionV2Service retrieves all the available relationships that an API user or MDM Cloud UI user can define between two person identities.Sample URLThe URL for this request is of the format https://custXXXX.verato-connect.com/link-...

An important component of Person Data Management is the ability to understand and define how two person identities are related to one another.With Verato, a user can create direct relationships between Person entities (mapped from LinkID to LinkID). Ver...

An important component of Person Data Management is the ability to understand and define how two person identities are related to one another.With Verato, a user can create direct relationships between Person entities (mapped from LinkID to LinkID). Ver...