Data Quality Components for Scribe Online:Personator:Settings
← Data Quality Components for Scribe Online
Actions
Actions are delimited with a “,” or “;”. Please do not put a space between the delimiters!
Check
The Check action will validate the individual input data pieces for validity and correct them if possible. If the data is correctable, additional information will often be appended as well. US and Canada only.
Verify
The Verify action will return to you the relationships between your different input data pieces. It can show you if your name, address, email, and phone number are correlated (belonging to the same person) or not. US only.
Move
The Move action will return the latest address for an individual or business if a previous address was entered. Move requires either a Last Name and Address, or a Business/Company Name and Address as inputs. US only. Move also returns results codes that help identify which addresses were updated with a move.
Append
The Append action will return elements based on the selected point of centricity which can either be the address, email or phone. For example, an address centric Append will return the name, company, phone and email associated with the given address. US only. Append also returns result codes which help you identify which elements were appended.
UsePreferredCity (off, on)
Default value is off.
For every city in the United States, there is an official name that is preferred by the U.S. Postal Service. There may be one or more unofficial or “vanity” names in use. Normally, Personator allows you to verify addresses using known vanity names. If the usePreferredCity is set to on, Personator will substitute the preferred city name for all vanity names when it verifies an address.
Diacritics (auto, on, off)
Default value is auto.
Determines whether or not French language characters are returned. If set to auto, those characters are only returned if they are in the input.
AdvancedAddressCorrection (off, on)
Default value is off.
US only. Uses the name input to perform more advanced address corrections. This can correct or append house numbers, street names, cities, states, and ZIP codes.
CentricHint (Auto, Address, Phone, Email)
Default value is Auto.
When set to Auto, it first uses Address if available, followed by Phone if no Address is available, and lastly Email if neither Address nor Phone are available. Use this to tell the service which piece of information to use as the primary pivot when verifying information.
Append (Blank, CheckError, Always)
Setting the Append option to Always will cause the service to return information all the time, regardless of whether the input address, phone, email, name or company is blank or incorrect.Setting the Append option to Blank will cause the service to return information only when the input address, phone, email, name or company is blank.Setting the Append option to CheckError will cause the service to return information when there are errors to either the address, phone, email, name or company. What an error entails are defined as follows:
- Address Error: If the input address was not found in the database, was not at the least partially verified, or could not be corrected. (does not contain AS01, AS02, or AS03).
- Phone Error: If the input phone number was not matched to either the 10 digit or 7 digit level at the least. (does not contain PS01 or PS02).
- Email Error: If the input email address was not found in the database, or if the email is unconfirmed. (does not contain ES01 or ES03).
- Name Error: If the input name did not parse successfully (does not contain NS01)
- Company Error: If the input company was blank.
Columns
Columns are delimited with a ",". The Personator Web Service returns specific columns for input data based on your needs. At a minimum, default columns are always returned. Default columns for specific actions are designated in the "Default Action" column. Beyond the default columns, you can request the presence of additional columns individually by specifying their column name, or the group that contains that column. GrpAll will return all the columns.
No Group (Default)
| Column Name | Group |
|---|---|
| ExtensionData | No Group
(These are the Default Colums) |
| AddressExtras | |
| AddressKey | |
| AddressLine1 | |
| AddressLine2 | |
| City | |
| CompanyName | |
| EmailAddress | |
| NameFull | |
| PhoneNumber | |
| PostalCode | |
| RecordExtras | |
| Reserved | |
| Results | |
| State |
No Group
| Column Name | Group |
|---|---|
| Plus4 | No Group |
| PriveateMailBox | |
| Suite |
Name Details
| Column Name | Group |
|---|---|
| Gender | GrpNameDetails |
| Gender2 | |
| NameFirst | |
| NameFirst2 | |
| NameLast | |
| NameLast2 | |
| NameMiddle | |
| NameMiddle2 | |
| NamePrefix | |
| NamePrefix2 | |
| NameSuffix | |
| NameSuffix2 | |
| Saluttaion |
Parsed Address
| Column Name | Group |
|---|---|
| AddressDeliveryInstallation | GrpParsedAddress |
| AddressHouseNumber | |
| AddressLockBox | |
| AddressPostDirection | |
| AddressPreDirection | |
| AddressPrivateMailboxName | |
| AddressPrivateMailboxRange | |
| AddressRouteService | |
| AddressStreetName | |
| AddressStreetSuffix | |
| AddressSuiteName | |
| AddressSuiteNumber |
Address Details
| Column Name | Group |
|---|---|
| AddressTypeCode | GrpAddressDetails |
| CarrierRoute | |
| CityAbbreviation | |
| CountryCode | |
| CountryName | |
| DeliveryIndicator | |
| DeliveryPointCheckDigit | |
| DeliveryPointCode | |
| StateName | |
| UTC | |
| UrbanizationName |
Census
| Column Name | Group |
|---|---|
| CBSACode | GrpCensus |
| CBSADivisionCode | |
| CBSADivisionLevel | |
| CBSADivisionTitle | |
| CBSALevel | |
| CBSATitle | |
| CensusBlock | |
| CensusTract | |
| CountyFIPS | |
| CountyName | |
| PlaceCode | |
| PlaceName |
Parsed Email
| Column Name | Group |
|---|---|
| DomainName | GrpParsedEmail |
| Mailboxname | |
| TopLevelDomain |
Parsed Phone
| Column Name | Group |
|---|---|
| NewAreaCode | GrpParsedPhone |
| PhoneExtension | |
| PhonePrefix | |
| PhoneSuffix | |
| AreaCode |
GeoCode
| Column Name | Group |
|---|---|
| Latitude | GrpGeoCode |
| Longitude |