Verato Enrich is available via a RESTful Web Service delivered using Verato’s Universal MPI technology. To request enrichment data for a given customer record, you may perform a demographicsQuery using the Enrich URL provided to you by Verato during onboarding.
This web service retrieves the single matching identity from Enrich that matches the demographic data provided in the web service request. The match determination is made using Verato’s referential matching algorithm, and a matching identity is only returned if the match scores above the match threshold configured during onboarding.
The demographicsQuery 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.
Sample URL
The URL for the Enrich demographicsQuery request is of the format https://custXXXX-enrich.verato-connect.com/link-ws/svc/demographicsQuery.
demographicsQuery Request
-
The demographicsQuery request is made up of demographic attribute data used to find a matching identity in the Enrich data set. Each attribute and attribute cluster in the request may contain zero-to-many values—for example, you could include no phone number in the query request or multiple phone numbers in the query request.
-
{ "trackingId": "string", "content": { "responseIdentityFormatNames": ["string"] "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" } ] } } }
demographicsQuery JSON response
-
The JSON response will include the corresponding confirmation attributes (e.g., Name, DOB, Address) from the Enrich identity, plus the Enrich attributes.
-
{ "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 }