nativeIdQuery

  • Web Services
  • UMPI
  • API Documentation

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 ID string, which is echoed back in the web service response. This allows you to track specific web service requests/responses using a customized message identifier relevant to your organization. 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.

nativeIdQuery JSON request

  • The request consists of:

    • Source+Native ID - If this Source+Native ID combination represents a customer record that was previously posted to Universal MPI, that previously-posted identity will be returned.

    • An optional string indicating which format to use in grouping Identity information in the web service response. The format options are ‘DEFAULT’, ‘GROUP_BY_SOURCE’, or specific smart view (or views).
      • If left blank, the ‘DEFAULT’ format is assumed. The ‘DEFAULT’ format groups the Identity information into a single Identity object
      • ‘GROUP_BY_SOURCE’ format groups the Identity information into one object for each source record (Source + Native ID)
      • Smart View(s) return identity information as configured
  • {
      "trackingId": "string", 
      "content":  { 
        "responseIdentityFormatNames": ["string"], 
      "source": { 
        "name": "string", 
        "id": "string" 
       } 
      } 
    } 

nativeID Query JSON response

Note
The web service response is the same for the following query web services: 

nativeIdQuerydemographicsQueryidentityQuery

  • 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 Link ID 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 Link ID
      • The demographic attribute data for the overall Universal MPI identity (which may include attribute data from multiple source records matched together into this single Link ID). The format of this identity object will vary depending on which format was requested in the web service request JSON.
  • {
      "trackingId": "string",
      "auditId": UUID, 
      "success": boolean, 
      "retryableError": boolean, 
      "message": "string", 
        "errors": [ 
          "string" 
         ], 
         "content": { 
           "linkId": "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" 
                ], 
                "linkId": "string", 
                "sources": [ 
                 {
                   "name": "string", 
                   "id": "string" 
                 } 
               ],
                "genders": [
                  "string" 
               ], 
                "datesOfBirth": [ 
                  "string" 
               ], 
                "phoneNumbers": [ 
                 { 
                   "number": "string", 
                   "areaCode": "string", 
                   "extension": "string",
                   "countryCode": "string" 
              } 
           ] 
         }
       }
    } 
  • {
      "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"
              }
            ]
          }
        ]
      }
    }