Uses the provided name to return validation and parsing information. This information includes a true/false that determines if the name is good as well as a confidence score. Beyond validation, NV3 also uses machine-learning to assess and classify input to distinguish between names and other types of inputs like business, dictionary, or garbage.

Run This Request in Postman

Test with this name:

Dr. John A. Smith

Check out the Integration Code in GitHub


GitHub

NameTypeDescription
FullNameStringThe full name to validate. Ex: “Dr. John A. Smith Sr.” Required if individual name inputs are not given.
PrefixStringThe prefix of the name to validate. Ex: “Dr.”
FirstNameStringThe first name to validate. Ex: “John”
MiddleNameStringThe middle name or initial to validate. Ex: “A.”
LastNameStringThe last name to validate. Ex: “Smith”
SuffixStringThe suffix of the name to validate. Ex: “Sr.”
OptionsStringComma Separated List of Options. See available options on the Options page.
AuthIDStringYour license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/name-validation/
  • ValidateNameResponse
NameTypeDescription
StatusStringAn indication of how the name fared in processing.
NameResultNameResultAn object containing details about the name. See NameResult table below.
StatusDetailStatusDetailA StatusDetail object will be returned in the case that the input name could not be validated. See StatusDetail table below.
  • NameResult
NameTypeDescription
StatusStringAn indication of how the name fared in processing. Possible values are “OK” for when the request was successful and a validation response was returned, “InvalidInput” for when an invalid request was made (such as not supplying the required inputs), “Unauthorized” for when an invalid or expired license key is used, and “Error” when an unexpected error occurred and the request could not be processed.
IsValidNameBooleanA True/False indication of the name’s validity.
ClassificationStringA determination made on the type of name. Possible values are “FullName”, “FirstName”, “LastName”, “DuoName”, “Business”, “Dictionary”, “Garbage”, or “Unknown”.
ConfidenceNumber (Double)A score (0-1) that indicates the confidence in the end result.
TextInStringA duplication of the input name as it was typed.
TextOutStringThe resulting name after validation.
ParsedNameParsedNameAn object that contains the parsed name after validation. See ParsedName table below.
PossibleNamesPossibleNames[]An array that contains a confidence score and the parsed name after validation for each input. This is only returned in cases where more than one name is supplied, such as in the case of a DuoName classification.
NotesstringA list of notes giving more details to the name validation result. See Notes for more information
WarningsstringA list of warnings giving more details to the name validation result. See Warnings for more information
FirstNameFoundBooleanA True/False indicating if the input first name was found during validation.
IsCommonFirstNameBooleanA True/False indicating if the input first name is a commonly found name.
LastNameFoundBooleanA True/False indicating if the input last name was found during validation.
IsCommonLastNameBooleanA True/False indicating if the input last name is a commonly found name.
SimilarFirstNamesStringA list of similar first names.
SimilarLastNamesStringA list of similar last names.
RelatedNamesStringA list of names related to the input name. For example, “Chris, Christian, Christoper, Christopher, Cristobal, Cristopher, Kris” for “Chris”.
  • ParsedName
NameTypeDescription
PrefixStringThe prefix of the name. Ex: “Dr.”
FirstStringThe first name. Ex: “John”
MiddleStringThe middle name or initial. Ex: “A.”
LastStringThe last name. Ex: “Smith”
SuffixStringThe suffix of the name. Ex: “Sr.”
  • StatusDetail
NameTypeDescription
MessageString A message that explains what the issue with processing was. See Errors for more information.
DetailString A more detailed explanation of the processing issue.