v1

latestOpenAPI 3.1.22026-08-062440.3 KB
Name Verification

Verify a name or company

This is the Global Name request.

Note: A License Key is required with either Company or FullName for this request.

get/doGlobalName

Query parameters

tstring

This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

idstring required

Required. The License Key issued by Melissa.

optstring

Options - Pass in options you want to set for the request. Options are listed in the OptionName:Parameter format with multiple options delimited with a ,.

  • CorrectFirstName:< ON | OFF > - ON will allow first name misspelling corrections. Default is OFF, preserve first name spellings; no correction allowed.

  • GenderAggression:< Code or Name > - Set how aggressively the service will attempt to genderize neutral first names. By default, Global Name will assign a value of “N” when attempting to genderize a first name that can easily be male or female, such as “Taylor,” “Chris,” or “Pat.” Using this property in conjunction with the GenderPopulation option, you can instruct the service on how much preference to give one gender over the other when assigning a gender to a normally neutral name.

    Either the Code or Name listed below can be used to set the action. For example, GENDERAGGRESSION:2 and GENDERAGGRESSION:Neutral are equivalent.

    • 1 or Aggressive - Aggressive name genderizing.
    • 2 or Neutral - Default. Neutral name genderizing.
    • 3 or Conservative - Conservative name genderizing.
  • GenderPopulation:< Code or Name > - Set the gender balance of the source data, predominantly male, predominantly female, or neutral. If you know that the majority of inputted names will be predominantly one gender, meaning that gender-neutral names will likely be of a particular gender, use this property to set the gender bias while genderizing names.

    Either the Code or Name listed below can be used to set the action. For example, GENDERPOPULATION:3 and GENDERPOPULATION:Female are equivalent settings.

    • 1 or Male - Bias towards Male.
    • 2 or Mixed - Default. No bias towards either gender.
    • 3 or Female - Bias towards Female.
  • LegacySalutation:< ON | OFF > - US/CAN only. This option will create a formal (Mr/Mrs) salutation from an assigned FirstName gender for US/CAN. Default is OFF.

  • NameHint:< Code or Name > - This option sets the most likely format of the FullName input string. This helps the service in cases where the order and formatting of the FullName input string are unclear.

    • Full or normal name order is: <Prefix> <First> <Middle> <Last> <Suffix>.
    • Inverse name order is: <Last> <Suffix>, <Prefix> <First> <Middle>.

    Either the Code or Name listed below can be used to set the action. For example, NAMEHINT:4 and NAMEHINT:Varying are equivalent settings.

    • 1 or DefinitelyFull - Name will always be treated as normal name order regardless of formatting or punctuation.
    • 4 or Varying - Default. If necessary, statistical logic will be employed to determine name order, with no bias toward either name order.
    • 7 or DefinitelyInverse - Name will always be treated as inverse name order, regardless of formatting or punctuation.
  • OverrideTransPrefix:< false | true > - US/CAN only. This option enables overwriting existing prefixes if an identified suffix has an associated prefix. Default is false.

  • RmTransSuffix:< false | true > - US/CAN only. This option enables or disables the removal of TransformSuffix if it exists. Default is false.

  • Salutation:< Formal | Informal | FirstLast | Slug | Blank > - This option creates a pipe delimited list of preferred salutation formats and precedence to use when generating salutations. There are five possible formats to use for creating salutations. The options in default order are:

    1. Formal - (e.g., "Mr. Smith MD")
    2. Informal - (e.g., "John")
    3. FirstLast - (e.g., "John Smith")
    4. Slug - (e.g., "Valued Customer")
    5. Blank - (e.g., "")

    example: opt=Salutation:Formal|FirstLast|Blank|Informal - This requests a formal salutation to be built where possible but would rather have a blank salutation than an informal salutation (this could replace a blank with a proprietary slug like ‘Valued Customer:’).

  • SalutationPrefix:<your-custom-prefix> - US/CAN only. Sets the prefix for the salutation name. Default value is Dear.

  • SalutationSlug:<your-custom-slug> - US/CAN only. Sets the text for substituting a name in salutations. Default value is Valued Customer.

  • SalutationSuffix:<your-custom-suffix> - US/CAN only. Sets the suffix for the salutation name. Default value is :.

  • StandardizeName:< ON | OFF > - This option enables or disables standardization of First, Middle and Last names allowing the user to retain original casing or prevent complex last name prefix modifications (such as St. or O' name overrides.) Default is ON.

  • StripPunctuation:< false | true > - This option enables or disables the removal of periods (.) from the name. Default is false.

  • TransformSuffix:< false | true > - US/CAN only. This option enables the creation of a limited number of associated prefixes like Dr. when the name contains an identified suffix such as MD or PhD. Default is false.

format'xml' | 'json'

Specify the desired format of the response (XML or JSON). Defaults to XML.

compstring

The company name to be standardized.

fullstring required

Required. The full name to be genderized, standardized, and parsed.

ctrystring

The country name or abbreviation of the input name.

Headers

Accept'application/json' | 'application/xml' | '*/*' required
Example:*/*

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Response

Global Name Response.

Versionstring

The current service version number.

TransmissionReferencestring

A unique identifier for this set of records. Returned as sent.

TransmissionResultsstring

Returns result codes for the request as a whole. For more information, see Global Name Result Codes.

TotalRecordsstring

Total number of records.