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

Name Type Description
FullName String The full name to validate. Ex: “Dr. John A. Smith Sr.” Required if individual name inputs are not given.
Prefix String The prefix of the name to validate. Ex: “Dr.”
FirstName String The first name to validate. Ex: “John”
MiddleName String The middle name or initial to validate. Ex: “A.”
LastName String The last name to validate. Ex: “Smith”
Suffix String The suffix of the name to validate. Ex: “Sr.”
Options String Comma Separated List of Options. See available options on the Options page.
AuthID String Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/name-validation/
  • ValidateNameResponse
Name Type Description
Status String An indication of how the name fared in processing.
NameResult NameResult An object containing details about the name. See NameResult table below.
StatusDetail StatusDetail A StatusDetail object will be returned in the case that the input name could not be validated. See StatusDetail table below.
  • NameResult
Name Type Description
Status String An 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.
IsValidName Boolean A True/False indication of the name’s validity.
Classification String A determination made on the type of name. Possible values are “FullName”, “FirstName”, “LastName”, “DuoName”, “Business”, “Dictionary”, “Garbage”, or “Unknown”.
Confidence Number (Double) A score (0-1) that indicates the confidence in the end result.
TextIn String A duplication of the input name as it was typed.
TextOut String The resulting name after validation.
ParsedName ParsedName An object that contains the parsed name after validation. See ParsedName table below.
PossibleNames PossibleNames[] 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.
Notes string A list of notes giving more details to the name validation result. See Notes for more information
Warnings string A list of warnings giving more details to the name validation result. See Warnings for more information
FirstNameFound Boolean A True/False indicating if the input first name was found during validation.
IsCommonFirstName Boolean A True/False indicating if the input first name is a commonly found name.
LastNameFound Boolean A True/False indicating if the input last name was found during validation.
IsCommonLastName Boolean A True/False indicating if the input last name is a commonly found name.
SimilarFirstNames String A list of similar first names.
SimilarLastNames String A list of similar last names.
RelatedNames String A list of names related to the input name. For example, “Chris, Christian, Christoper, Christopher, Cristobal, Cristopher, Kris” for “Chris”.
  • ParsedName
Name Type Description
Prefix String The prefix of the name. Ex: “Dr.”
First String The first name. Ex: “John”
Middle String The middle name or initial. Ex: “A.”
Last String The last name. Ex: “Smith”
Suffix String The suffix of the name. Ex: “Sr.”
  • StatusDetail
Name Type Description
Message String  A message that explains what the issue with processing was. See Errors for more information.
Detail String  A more detailed explanation of the processing issue.