demographicsQuery

  • Web Services
  • UMPI
  • API Documentation

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 only returned if the match scores above the same match threshold used for determining matches during the postIdentity add/update process.

Like the postIdentity web service, the query web services allow the client to provide a “tracking ID” string that is client-generated, which is echoed back in the web service response. This provides the ability to track specific web service requests/responses using a message identifier that is meaningful to the client. In addition to the “tracking ID” in the web service request, the content of the query request will vary across the three different query web services.

The web service response is consistent across all three (nativeIdQuery, identityQuery, demographicsQuery) of the query web services.

demographicsQuery request

  • The demoGraphicsQuery request is made up of demographic attribute data  used to find a matching identity in Universal MPI. Each attribute and attribute cluster in the request may contain zero-to-many values – for example, you could include no phone number in the query request or multiple phone numbers in the query request.

  • {
        "trackingId": "string",
        "content": {
          "responseIdentityFormatNames": ["string"],
          "identity": {
            "emails": [
              "string"
          ],
          "addresses": [
            {
              "line1": "string",
              "line2": "string",
              "city": "string",
              "state": "string",
              "postalCode": "string"
            }
          ],
          "names": [
            {
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string"
            }
          ],
          "ssns": [
            "string"
          ],
          "genders": [
            "string"
          ],
          "datesOfBirth": [
            "string"
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "areaCode": "string",
              "extension": "string",
              "countryCode": "string"
            }
          ]
        }
      }
    } 

demographicsQuery JSON response - DEFAULT

  • The response includes:

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service (see section 3.1 above for more information)
    • The LinkID of the identity returned from the query
    • An identity object consisting of both of the following:
      • The list of Source+Native ID values that are associated with the LinkID
      • The demographic attribute data for the overall Universal MPI identity (which may include attribute data from multiple source records matched together into this single LinkID). The format of this identity object will vary depending on which format was requested in the web service request JSON.
  • {
      "trackingId": "string",
      "content": {
        "responseIdentityFormatNames": ["string"],
        "identity": {
        "emails": [
          "string"
         ],
         "addresses": [
            {
              "line1": "string",
              "line2": "string",
              "city": "string",
              "state": "string",
              "postalCode": "string"
            }
          ],
         "names": [
          {
            "first": "string",
            "middle": "string",
            "last": "string",
            "suffix": "string"
          }
          ],
          "ssns": [
            "string"
          ],
          "genders": [
            "string"
          ],
          "datesOfBirth": [
            "string"
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "areaCode": "string",
              "extension": "string",
              "countryCode": "string"
            }
          ]
        }
      }
    }

demographicsQuery JSON response - GROUP_BY_SOURCE 

If the  GROUP_BY_SOURCE identity response format is requested, the JSON object for the body is as follows:  

{
  "trackingId": "string",
  "auditId": UUID,
  "success": boolean,
  "retryableError": boolean,
  "message": "string",
  "errors": [
    "string"
  ],
  "content": {
    "linkId": "string",
    "identityGroupedBySource": [
      {
        "emails": [
          {
            "email": "string",
            "lastAsserted": "string",
            "firstAsserted": "string"
          }
        ],
        "addresses": [
          {
            "address": {
            "city": "string",
            "postalCode": "string",
            "state": "string",
            "line2": "string",
            "line1": "string"
          },
          "lastAsserted": "string",
          "firstAsserted": "string"
        }
      ],
        "names": [
          {
            "name": {
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "first": "string"
            },
            "lastAsserted": "string",
            "firstAsserted": "string"
          }
        ],
        "ssns": [
          {
            "ssn": "string",
            "lastAsserted": "string",
            "firstAsserted": "string"
          }
        ],
        "genders": [
          {
            "gender": "string",
            "lastAsserted": "string",
            "firstAsserted": "string"
          }
        ],
        "source": {
          "name": "string",
          "id": "string"
        },
        "datesOfBirth": [
          {
            "dateOfBirth": "string",
            "lastAsserted": "string",
            "firstAsserted": "string"
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": {
            "number": "string",
            "areaCode": "string",
            "countryCode": "string"
          },
          "lastAsserted": "string",
          "firstAsserted": "string"
          }
        ]
      }
    ]
  }
}