Web Service API Reference Guide

Verato RESTful API web services for developers.

  • createDataSource

    If you have large volumes of data sources and frequent additions to your list of data sources, you can use the createDataSource web service creates a new, valid data source in the UMPI. Newly added data source may takes about 10-15 minutes become avail...

  • deleteSourceIdentity

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

  • demographicsQuery

    This web service retrieves the single matching identity from Universal MPI 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 is o...

  • demographicsSearch

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

  • householdQuery

    "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. Refer to Wh...

  • identityIdQuery

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

  • linkIdentities

    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 LinkID. This service would be used on an exception basis, if you discover scenarios where you have ...

  • mergeIdentities

    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 LinkID and convert one of the customer source records into a retired/merged state. The customer so...

  • nativeIdQuery

    The nativeIdQuery web service retrieves the single matching identity from Universal MPI 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 tracking...

  • postIdentity

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

  • searchNotifications

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

  • unlinkIdentities

    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 LinkID. This service can be used to do one of the following:  Reverse the outcome of a l...

  • unmergeIdentities

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

  • Verato UMPI Connector Module Reference

    Configurations Config  Parameters (scroll down) Name Type Description Default Value Required Name String The name for this configuration. Connectors reference the configuration with this name. x   Connection Basic Auth Secure Sche...