Verato API V2

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 version of API responses.

{
  "trackingId": "string",
  "auditId": UUID, 
  "success": boolean, 
  "retryableError": boolean, 
  "message": "string", 
    "errors": [
      "string" 
    ], 
    "content": { 
      "linkId": "string", 
      "identity": { 
        "emails": [ 
          "string"
        ], 
        "addresses": [ 
          { 
            "clusterStatus": "string"
            "line1": "string", 
            "line2": "string",
            "city": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string"
          } 
         ], 
         "names": [ 
           { 
              "clusterStatus": "string",
              "first": "string", 
              "middle": "string", 
              "last": "string", 
              "suffix": "string" 
           } 
         ], 
            "ssns": [ 
           "string" 
         ], 
            "linkId": "string", 
            "sources": [ 
           {
                "name": "string", 
                "id": "string" 
           } 
         ],
            "genders": [
           "string" 
         ], 
            "datesOfBirth": [ 
           "string" 
         ], 
            "phoneNumbers": [ 
           { 
              "clusterStatus": "string",
              "number": "string", 
              "areaCode": "string", 
              "extension": "string",
              "countryCode": "string" 
           } 
       ] 
     }
  }

As part of Verato's October 2025 release, Verato’s Patient Journey APIs also include new v2 API versions, where all clusters (including SSN, DOB, Email, Gender) are returned as objects and include the clusterStatus property.

The following APIs have a v2 version:

• postIdentity

• demographicsSearch

• demographicsQuery

• identityIdQuery

• nativeIdQuery

To call V2 versions of the current Patient Journey APIs, an API user would post in the following request new format:

…/svc/v2/postIdentity
…/svc/v2/identityIdQuery

How the v2 version affects API responses

Comparing the V1 and V2 versions, notice that the V2 version returns ALL attribute clusters as an object (including SSN, DOB, Email, and Gender) as shown below:

 "datesOfBirth": [
    {
      "firstAsserted": "dateTime",
      "lastAsserted": "dateTime,
      "dateOfBirth": {
        "clusterStatus": "string",
        "dateOfBirth": "string"
      }
    }
  ],
  "ssns": [
    {
      "firstAsserted": "dateTime",
      "lastAsserted": "dateTime,
      "ssn": {
        "clusterStatus": "string",
        "ssn": "string"
      }
    }
  ],
  "genders": [
    {
      "firstAsserted": "dateTime",
      "lastAsserted": "dateTime,
      "gender": {
        "clusterStatus": "string",
        "genderDisplay": "string"
        "gender": "string"
      }
    }
  ],
  "emails": [
    {
      "firstAsserted": "dateTime",
      "lastAsserted": "dateTime,
      "email": {
        "clusterStatus": "string",
        "email": "string",
        "type": "string",
        "typeDisplay": "string"
      }
    }
  ]