Verato has released an enhanced demographicsQuery endpoint for its Enrich web service.
The following steps are needed to upgrade your existing Enrich demographicsQuery API to the new endpoint.
1. Endpoint URL
The URL for the upgraded Enrich demographicsQuery API is https://custXXXX-enrich.verato-connect.com/link-ws/svc/demographicsQuery, where custXXXX is unique to a customer.
2. demographicsQuery Request
-
The body of the API request remains the same except for the addition of a responseIdentityFormatNames key that must contain the name of an Enrich supported Smart View. The JSON example includes the additional responseIdentityFormatNames.
-
{ "trackingId": "string", "content": { "responseIdentityFormatNames": ["ENRICH_ALL"] "identity": { "addresses": [ { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string" } ], "names": [ { "first": "string", "last": "string" } ], "ssns": [ "string" ], "genders": [ "string" ], "datesOfBirth": [ "string" ], "phoneNumbers": [ { "number": "string", "areaCode": "string", "extension": "string", "countryCode": "string" } ] } } }
3. demographicsQuery response
-
The API response organizes the Enrich attributes in more specific data clusters where one or more data attributes are organized based on their meaning and purpose. The JSON is an example of an Enrich API response with a subset of data attributes. Note the actual response is based on the responseIdentityFormatNames key that is passed in the JSON request.
-
{ "success": true, "message": "Identity Found!", "content": { "linkId": "string", "customizedIdentities": { "string": { "linkId": "string", "sources": [ { "name": "string", "id": "string" }, ], "names": [ { "first": "string", "middle": "string", "last": "string" }, ], "datesOfBirth": [ "string" ], "addresses": [ { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string" }, "genders": [ "M" ], "phoneNumbers": [ { "number": "string", "areaCode": "string" } ], "emails": [ "sample001@verato.com" ], "custom.education": [ { "education": "string", "educationOrdinal": "string" } ], "custom.maritalStatus": [ { "maritalStatus": "string" } ], "custom.age": [ { "age": "string" } ], "custom.ethnicGroup": [ { "ethnicGroup": "string" } ], "custom.ethnicDetail": [ { "ethnicDetail": "string" } ], "custom.language": [ { "language": "string" } ], "custom.religion": [ { "religion": "string" } ], "custom.householdIncome": [ { "householdIncome": "string", "householdIncomeMidpoint": "string" } ], "custom.email-outreach": [ { "emailAddress": "string", "updateDate": "string", "domain": "string", "emailQualityLevel": "string", "emailOptIn": "string", "rankOrder": "string" }, ], "custom.phone-outreach": [ { "phoneType": "string", "updateDate": "string", "phone": "string", "dnc": "string", "phoneQualityLevel": "string", "workPhone": "string", "rankOrder": "string" } ] } }, "customizedIdentitiesWithSources": { "string": { "linkId": "string", "sources": [ { "name": "string", "id": "string" } ], "namesWithSources": [ { "first": "string", "middle": "string", "last": "string", "source": [ { "name": "string", "id": "string" } ] } ], "datesOfBirthWithSource": [ { "dateOfBirth": "string", "source": [ { "name": "string", "id": "string" } ] } ], "addressesWithSource": [ { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string", "source": [ { "name": "string", "id": "string" } ] } ], "gendersWithSource": [ { "gender": "string", "source": [ { "name": "string", "id": "string" } ] } ], "phoneNumbersWithSource": [ { "number": "string", "areaCode": "string", "source": [ { "name": "string", "id": "string" } ] } ], "emailsWithSources": [ { "email": "string", "source": [ { "name": "string", "id": "string" } ] } ], "propertyWithSource": { "custom.education": [ { "properties": { "education": "string", "educationOrdinal": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.maritalStatus": [ { "properties": { "maritalStatus": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.age": [ { "properties": { "age": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.ethnicGroup": [ { "properties": { "ethnicGroup": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.ethnicDetail": [ { "properties": { "ethnicDetail": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.language": [ { "properties": { "language": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.religion": [ { "properties": { "religion": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.householdIncome": [ { "properties": { "householdIncome": "string", "householdIncomeMidpoint": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.email-outreach": [ { "properties": { "emailAddress": "string", "updateDate": "string", "domain": "string", "emailQualityLevel": "string", "emailOptIn": "string", "rankOrder": "string" }, "source": [ { "name": "string", "id": "string" } ] } ], "custom.phone-outreach": [ { "properties": { "phoneType": "string", "updateDate": "string", "phone": "string", "dnc": "string", "phoneQualityLevel": "string", "workPhone": "string", "rankOrder": "string" }, "source": [ { "name": "string", "id": "string" } ] } ] }, "unmergeable": [] } } }, "trackingId": "string", "auditId": "string", "retryableError": false }