identityIdQuery

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-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.

Sample URL

The URL for this request is of the format https://custXXXX.verato-connect.com/link-ws/svc/identityIdQuery, where XXXX is a 4-digit number.

identityIdQuery JSON request

• The identityIdQuery consists of:

  • Link ID - If this Link ID value is assigned to an identity in Universal Identity, the identity is 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"],
       "linkId": "string"
    }
  }
  

identityIdQuery JSON response - DEFAULT

• If the DEFAULT identity response format is requested or no response was specified, the JSON object for the body 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 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.
      Note
      Verato Universal Identity now offers real-time, CASS-certified U.S. address verification. When enabled, this feature enriches all addresses within the identity with extra details. These include residential status, vacancy status, extended ZIP code, geographical coordinates, and more. Every address in the API response will also contain additional fields, as detailed here.

• {
    "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",
              "country": "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" 
             } 
         ] 
       }
    }    

identityIdQuery JSON response - GROUP_BY_SOURCE 

• If the GROUP_BY_SOURCE identity response format is requested or no response was specified, the JSON object for the body 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 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.
      Note
      Verato Universal Identity now offers real-time, CASS-certified U.S. address verification. When enabled, this feature enriches all addresses within the identity with extra details. These include residential status, vacancy status, extended ZIP code, geographical coordinates, and more. Every address in the API response will also contain additional fields, as detailed here.

• {
    "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",
              "line1": "string",
              "line2": "string",
              "country": "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"
            }
          ]
        }
      ]
    }
  }