Page tree
Skip to end of metadata
Go to start of metadata



Uses the provided name to return information such as classification, gender if a person, origin, similar names, related names and validity results.


URL Endpoints


JSON: 

https://trial.serviceobjects.com/NV2/api.svc/NameInfoV2/{NAME}/{OPTION}/{LICENSEKEY}?format=json

XML: 

 https://trial.serviceobjects.com/NV2/api.svc/NameInfoV2/{NAME}/{OPTION}/{LICENSEKEY}?format=xml

NameInfoV2 Inputs


Name

Type

Description

Name

String

The name to validate.

OptionStringComma Separated List of Options. See available options on the Options page.

LicenseKey

String

Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/products/demographics-more/name-validation

 

NameInfoV2 Outputs 


NameInfoV2

If no errors are encountered a NameInfoV2 element will be returned with the following information. If there is an error, an Error object will be returned.

Name

Type

Description

BestGuessNameNV2NameThe best guess name if a name was unable to be validated. (NV2Name is defined in the next table)
NameInStringThe name as it was provided as input.
NameClassificationStringA determination made on the name whether it is believed to be a "Person","Business" or "Unknown"

Prefix

String

The parsed out prefix (Mr, Mrs, etc)

FirstName

String

The parsed first name.

MiddleName

String

The parsed middle name.

LastName

String

The parsed last name

Suffix

String

The parsed suffix (Jr, Sr, II, etc)

FirstNameFound

Bool

Is the first name found in existing name tables (True / False)

IsCommonFirstName

Bool

Is the first name one of the most common first names in existing data (True / False)

FirstNameOrigin

String

National origin of the first name (Old-English, etc)

FirstNameSimilarStringNames that phonetically sound the same as the given first name.

LastNameFound

Bool

Is the last name found in existing name tables (True / False)

IsCommonLastName

Bool

Is the last name one of the most common first names in existing data (True / False)

LastNameOriginStringNational origin of the last name (Old-English, etc)
LastNameSimilarStringNames that phonetically sound the same as the given last name.

Gender

String

The likely gender of the name (Male, Female, Neutral)

FirstNameAlt

String

If more than one first name is found, the second first name (ex: John and Mary Smith)

MiddleNameAlt

String

If more than one middle name is found, the second middle name

LastNameAlt

String

If more than one last name is found, the second last name

FirstNameAltFound

Bool

Is the alternative first name found in existing name tables (True / False)

LastNameAltFound

Bool

Is the last name found in existing name tables (True / False)

GenderAlt

String

If more than one name is present, the gender of the second name

RelatedNames

String

Names related to the first name (Bill, Billy, Billie, etc)

IsCorrectedNameboolIf the name has been corrected to produce a better result.
IsBusinessNameboolIf the provided name is a business name.
BusinessNameStringThe business name if the name provided was determined to be a business name.

VulgarityScore

Int

A score ranging from 0 to 5 indicating the likelihood the given name is a vulgar word or phrase. A score of 5 would be very likely and 0 would be not at all likely.

CelebrityScore

Int

A score ranging from 0 to 5 indicating the likelihood the given name is a celebrity. A score of 5 would be very likely and 0 would be not at all likely.

BogusScore

Int

A score ranging from 0 to 5 indicating the likelihood the given name is not a name but simply a word or phrase. A score of 5 would be very likely and 0 would be not at all likely.

GarbageScore

Int

A score ranging from 0 to 5 indicating the likelihood the given name is not a name but rather a series of random letters. A score of 5 would be very likely and 0 would be not at all likely.

FirstNameDictionaryScore

Int

A score ranging from 0 to 5 indicating the likelihood the given First name is not a name but a dictionary word. E.g., "Car" is strictly a dictionary word, but "Mark" is both a word and a name. A score of 5 would be very likely and 0 would be not at all likely.

MiddleNameDictionaryScoreIntA score ranging from 0 to 5 indicating the likelihood the given Middle name is strictly a dictionary word. E.g., "Car" is strictly a dictionary word, but "Mark" is both a word and a name. A score of 5 would be very likely and 0 would be not at all likely.

LastNameDictionaryScore

Int

A score ranging from 0 to 5 indicating the likelihood the given Last name is strictly a dictionary word. E.g., "Car" is strictly a dictionary word, but "Mark" is both a word and a name. A score of 5 would be very likely and 0 would be not at all likely.

OverallNameScore [1]

IntA score ranging from 0 to 5 Indicating the quality of a given name. A score of 5 indicates the highest quality name, while a score of 0 indicates the lowest quality name. A name that is determined to be a business will be given a default score of 3.
IsNameGoodStringAn analysis of whether or not the name is valid based on the results of the returned scores ("true", "false", or "unknown")
StatusCodesIntA code indicating penalties or extra information about a given name.

Status

String

A field offering more information about this name. Can contain messages offering suggestions for interpreting the name, etc.


NV2Name

A structure containing name information in the event a validated name could not be found.

NameTypeDescription
PrefixStringThe parsed out prefix (Mr, Mrs, etc)
FirstNameStringThe parsed out first name.
MiddleNameStringThe parsed out middle name.
LastNameStringThe parsed out Last Name.
SuffixString

The parsed suffix (Jr, Sr, II, etc)


References

  1. ^ DOTS Name Validation 2: What Do The Scores Mean?

http://ws.serviceobjects.com/NV2/api.svc/NameInfoV2/{NAME}/{OPTION}/{LICENSEKEY}?format=xml

  • No labels