The sourceRecordsQuery web service retrieves the matching identity objects from Universal Identity that contain the one or more Source+Native IDs provided in the web service request while optionally limiting what clusters are returned.
The purpose of this endpoint is to reduce latency when retrieving demographic information for specific source records.
Sample URL
The URL for this request is of the format https://custXXXX.verato-connect.com/provider-link-ws/svc/sourceRecordsQuery , where XXXX is a 4-digit number.
sourceRecordsQuery 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 Identity, 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.
- An optional array of what clusters are returned as part of the identity object of each source record:
- If left blank, all clusters are returned as part of the response.
{ "content": { "responseIdentityFormatNames": [ "DEFAULT" ], "sources": [ { "source": "string", "nativeId": "string" }, { "source": "string", "nativeId": "string" } ], "requiredClusters": [ "string", "string" ] //optional } }
sourceRecordsQuery JSON response
-
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
- The Link ID of the identity returned from the query
- One or more identity object consisting of both of the following – depending on how many source records were requested:
- 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 and the required clusters defined in the request.
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 . { "success": true, "message": "string", "content": { "records": [ { "source": { "name": "string", "displayName": "string", "tier": 1 }, "nativeId": "string", "linkId": "string", "identity": { "sources": [ { "name": "string", "id": "string" } ], "names": [ { "clusterStatus": "string", "first": "string", "middle": "string", "last": "string", "suffix": "string", "prefix": "string", "credential": "string" } ], "authorizedOfficials": [], "genders": [ { "clusterStatus": "string", "gender": "string" } ], "npis": [ { "clusterStatus": "string", "npi": "string", "entityTypeCode": "string" } ], "license": [ { "clusterStatus": "string", "number": "string", "state": "string", "taxonomyCode": "string", "licenseEffectiveDate": "string", "licenseExpirationDate": "string" } ], "addresses": [ { "clusterStatus": "string", "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string", "addressType": "string", "addressName": "string", "verifiedAddress": { "urbanization": "string", "primaryNumber": "string", "streetName": "string", "streetPredirection": "string", "streetPostdirection": "string", "streetSuffix": "string", "secondaryNumber": "string", "secondaryDesignator": "string", "extraSecondaryNumber": "string", "extraSecondaryDesignator": "string", "pmbDesignator": "string", "pmbNumber": "string", "city": "string", "cityAka": "string", "state": "string", "zip": "string", "zip4": "string", "deliveryPoint": "string", "deliveryPointCheckDigit": "string" }, "verifiedAddressMetaData": { "verificationCode": "string", "verificationCodeDescription": "string", "rdi": "string", "vacant": false, "cmra": false, "latitude": number, "longitude": number, "precision": "string", "congressionalDistrict": "string", "countyFips": "string", "countyName": "string" }, "country": "string", "district": "string", "latitude": "string" } ], "emails": [ { "clusterStatus": "string", "email": "string", "type": "string", "validTo": "string", "validFrom": "string" } ], "specialties": [ { "clusterStatus": "string", "specialtyTaxonomyCode": "string", "grouping": "string", "classification": "string", "specialization": "string" } ], "locationInfo": [ { "clusterStatus": "string", "ruralUrbanSuburban": "string", "coloCode": "string" } ], "education": [ { "clusterStatus": "string", "medSchool": "string", "gradYear": "string" } ], "medicareInfo": [ { "clusterStatus": "string", "inPecos": "string", "acceptsMedicare": "string" } ], "practiceInfo": [ { "clusterStatus": "string", "estimatedPracticeYears": "string" } ], "phoneNumbers": [ { "clusterStatus": "string", "number": "string", "type": "string", "validTo": "string", "validFrom": "string" } ], "faxNumbers": [ { "clusterStatus": "string", "type": "string", "number": "string", "validTo": "string", "validFrom": "string" } ], "externalUniqueIdentifier": [ { "clusterStatus": "string", "issuer": "string", "value": "string", "status": "string", "startDate": "string", "endDate": "string" } ], "datesOfBirth": [ { "clusterStatus": "string", "dateOfBirth": "string" } ], "deathDetails": [ { "clusterStatus": "string", "deceased": "string" } ], "ethnicities": [ { "clusterStatus": "string", "ethnicity": "string" } ], "qualifications": [ { "clusterStatus": "string", "qualification": "string", "issueDate": "string", "issuer": "string", "status": "string", "type": "string", "validFrom": "string", "validTo": "string" } ], "religiousAffiliations": [ { "clusterStatus": "string", "religiousAffiliation": "string" } ], "ssns": [ { "clusterStatus": "string", "ssn": "string" } ], "contactInformation": [ { "clusterStatus": "string", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string", "addressType": "string", "addressName": "string", "country": "string", "district": "string", "latitude": "string", "longitude": "string", "validFrom": "string", "validTo": "string" }, "phoneList": [ { "number": "string", "type": "string", "validTo": "string", "validFrom": "string" } ], "faxList": [ { "type": "string", "number": "string", "validTo": "string", "validFrom": "string" } ] } ], "alternateIdentifiers": [ { "clusterStatus": "string", "type": "string", "issuer": "string", "value": "string", "startDate": "string", "endDate": "string", "description": "string", "issueDate": "string", "status": "string" } ] } } ] }, "auditId": "string", "retryableError": false }{ "success": true, "message": "Records found!", "content": { "records": [ { "source": { "name": "string", "displayName": "string", "tier": number }, "nativeId": "string", "linkId": "string", "identityGroupedBySource": [ { "source": { "name": "epic_providers", "id": "201013" }, "names": [ { "firstAsserted": "string", "lastAsserted": "string", "name": { "first": "string", "last": "string" } } ], "datesOfBirth": [ { "firstAsserted": "string", "lastAsserted": "string", "dateOfBirth": "string" } ], "ssns": [ { "firstAsserted": "string", "lastAsserted": "string", "ssn": "string" } ], "addresses": [ { "firstAsserted": "string", "lastAsserted": "string", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string" } } ], "genders": [ { "firstAsserted": "string", "lastAsserted": "string", "gender": "string" } ], "emails": [ { "firstAsserted": "string", "lastAsserted": "string", "email": "string", "type": "string" } ], "phoneNumbers": [ { "firstAsserted": "string", "lastAsserted": "string", "number": "string", "areaCode": "string", "extension": "string", "countryCode": "string" } ] } ] } ] }, "auditId": "string", "retryableError": false, "warnings": [] }