Sign in

v1

latestOpenAPI 3.1.22026-08-062493.4 KB
Consumer Verification

Verify consumers

Submit a batch request to verify consumers.

The service requires at least one of the following input combinations:

Set A - AddressLine1, PostalCode

Set B - AddressLine1, City, State

Set C - AddressLine1, LastLine

Set D - EmailAddress

Set E - PhoneNumber

Set F - FullName

Set G - IPAddress

Set H - FreeForm

Set I - MelissaAddressKey

Set J - MelissaIdentityKey

Note: The minimum input requirements differ depending on the Action(s) selected. Please check the documentation for more details.

post/doContactVerify

Headers

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

Format of the response.

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

Format of the request.

Request body

TransmissionReferencestring

Serves as a unique request identifier.

CustomerIDstring required

Required. The License Key issued by Melissa.

Actions'Check' | 'Verify' | 'Move' | 'Append' required

Actions - The action(s) to take. Delimit multiple actions with a ,.

Columnsstring

Columns - The column names or groups to be output.

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Delimit multiple columns with a ,.

For example: ColumnName,ColumnName.

Columns:

<details>
<summary> [No Group] - These fields have no group and have to be requested by the field name. </summary>

  - `DateLastConfirmed`
  - `EstimatedHomeValue`
  - `MelissaIdentityKey`
  - `MoveDate`
  - `Occupation`
  - `OwnRent`
  - `PhoneCountryCode`
  - `PhoneCountryName`
  - `Plus4`
  - `PrivateMailBox`
  - `Suite`

</details>
<details>
<summary> <code>GrpAddressDetails</code> - Address Details </summary>

  - `AddressTypeCode`
  - `CarrierRoute`
  - `CityAbbreviation`
  - `CountryCode`
  - `CountryName`
  - `DeliveryIndicator`
  - `DeliveryPointCheckDigit`
  - `DeliveryPointCode`
  - `StateName`
  - `UrbanizationName`
  - `UTC`

</details>
<details>
<summary> <code>GrpCensus</code> - Census Details </summary>

  - `CBSACode`
  - `CBSADivisionCode`
  - `CBSADivisionLevel`
  - `CBSADivisionTitle`
  - `CBSALevel`
  - `CBSATitle`
  - `CensusBlock`
  - `CensusTract`
  - `CongressionalDistrict`
  - `CountyFIPS`
  - `CountyName`
  - `PlaceCode`
  - `PlaceName`

</details>
<details>
<summary> <code>GrpCensus2</code> - Additional Census Details </summary>

  - `CensusKey`
  - `CountySubdivisionCode`
  - `CountySubdivisionName`
  - `ElementarySchoolDistrictCode`
  - `ElementarySchoolDistrictName`
  - `SecondarySchoolDistrictCode`
  - `SecondarySchoolDistrictName`
  - `UnifiedSchoolDistrictCode`
  - `UnifiedSchoolDistrictName`
  - `StateDistrictUpper`
  - `StateDistrictLower`

</details>
<details>
<summary> <code>GrpGeocode</code> - Geocode Details </summary>

  - `Latitude`
  - `Longitude`

</details>
<details>
<summary> <code>GrpDemographicBasic</code> - Basic Demographics </summary>

  - `ChildrenAgeRange`
  - `CreditCardUser`
  - `DateOfBirth`
  - `DateOfDeath`
  - `DemographicsGender`
  - `DemographicsResults`
  - `Education`
  - `EthnicCode` (Deprecated)
  - `EthnicGroup` (Deprecated)
  - `HouseholdIncome`
  - `HouseholdSize`
  - `LengthOfResidence`
  - `MaritalStatus`
  - `MedianHouseholdIncome`
  - `PoliticalParty`
  - `PresenceOfChildren`
  - `PresenceOfSenior`

</details>
<details>
<summary> <code>GrpIPAddress</code> - IP Address Details </summary>

  - `DistanceAddressToIP`
  - `IPAddress`
  - `IPCity`
  - `IPConnectionSpeed`
  - `IPConnectionType`
  - `IPContinent`
  - `IPCountryAbbreviation`
  - `IPCountryName`
  - `IPDomainName`
  - `IPISPName`
  - `IPLatitude`
  - `IPLongitude`
  - `IPPostalCode`
  - `IPProxyDescription`
  - `IPProxyType`
  - `IPRegion`
  - `IPUTC`

</details>
<details>
<summary> <code>GrpNameDetails</code> - Name Details </summary>

  - `Gender`
  - `Gender2`
  - `NameFirst`
  - `NameFirst2`
  - `NameLast`
  - `NameLast2`
  - `NameMiddle`
  - `NameMiddle2`
  - `NamePrefix`
  - `NamePrefix2`
  - `NameSuffix`
  - `NameSuffix2`
  - `Salutation`

</details>
<details>
<summary> <code>GrpParsedAddress</code> - Parsed Address Details </summary>

  - `AddressDeliveryInstallation`
  - `AddressHouseNumber`
  - `AddressLockBox`
  - `AddressPostDirection`
  - `AddressPreDirection`
  - `AddressPrivateMailboxName`
  - `AddressPrivateMailboxRange`
  - `AddressRouteService`
  - `AddressStreetName`
  - `AddressStreetSuffix`
  - `AddressSuiteName`
  - `AddressSuiteNumber`

</details>
<details>
<summary> <code>GrpParsedEmail</code> - Parsed Email Details </summary>

  - `DomainName`
  - `MailboxName`
  - `TopLevelDomain`

</details>
<details>
<summary> <code>GrpParsedPhone</code> - Parsed Phone Details </summary>

  - `AreaCode`
  - `NewAreaCode`
  - `PhoneExtension`
  - `PhonePrefix`
  - `PhoneSuffix`

</details>
Optionsstring

Options - Specify which options to use for the selected action. List of options in <OptionName>:<Parameter> format. Multiple options are delimited with a ;.

For example: OptionName:Parameter;OptionName:Parameter.

  • AdvancedAddressCorrection:< On | Off > - Uses the name input to perform more advanced address corrections. This can correct or append house numbers, street names, cities, states, and ZIP codes. Default of Off means no advanced address corrections will occur.
  • AdvancedAddressType:< On | Off > - This option allows you to select whether to return the simplified address type codes or the advanced and more complete address type codes. Default of Off means only Default Address Types are returned (S, G, M, P, R, and U).
  • AliasMode:< ConvertAlias | PreserveAlias > - Option to convert an address to the USPS preferred street name or preserve the original address. Default of ConvertAlias will convert the street address alias to the USPS preferred street name.
  • Append:< Blank | CheckError | Always > - Determines the behavior when appending information. Default of Blank returns information only when the input field is blank.
  • CentricHint:< Auto | Address | Phone | Email > - This option tells the service which piece of information to use as the primary pivot when verifying information. Default of Auto first uses Address if available, followed by Phone if no Address is available, and lastly Email if neither Address nor Phone are available.
  • CorrectFirstName:< On | Off > - Default of On allows common spelling corrections for the FirstName field.
  • CorrectSyntax:< On | Off > - Default of On corrects the syntax of the Email field.
  • DatabaseLookup:< On | Off > - Default of On will attempt to verify domain names using a database of valid domains.
  • DecennialCensusKey:< Off | 2020 | 2010 > - Set the preferred Census information returned, whether the latest one or the decennial version. Default of Off returns the latest Census information available.
  • Demographics:< Yes | Mask | MaskOnly | ValueOnly > - Determines the data masking of demographics columns. Default of Yes means no data masking will be performed.
  • Diacritics:< Auto | On | Off > - Determines whether or not French language characters are returned. Default of Auto will only return those characters if they are in the input.
  • EmailAppendFilter:< [blank] | CatchAll | SpamTrap > - option to prevent certain categories of emails to append, including accept-all/catch-all emails and spam trap emails. Default of [blank] means no filtering will be done.
  • FuzzyLookup:< On | Off > - Determines whether or not to apply fuzzy matching algorithms to the input domain for correction. Default of On will apply fuzzy matching correction to the domain.
  • GenderAggression:< Neutral | Conservative | Aggressive > - Sets how aggressive genderization is for neutral first names. Default of Neutral sets gender aggression to neutral.
  • GenderPopulation:< Mixed | Male | Female > - Sets the gender balance of the source data, either predominantly male, female, or mixed (evenly split). Default of Mixed sets source data gender balance to mixed.
  • LongAddressFormat:< Off | On | Auto > - Controls how abbreviations of suffixes and directionals are handled when standardizing a street address. Default of Off will abbreviate suffixes and directionals.
  • MiddleNameLogic:< ParseLogic | HypenatedLast | MiddleName > - Determines the handling of middle names. Default of ParseLogic means that middle names that are typically last names are considered to be part of a hyphenated last name.
  • NameHint:< Varying | DefinitelyFull | VeryLikelyFull | ProbablyFull | ProbablyInverse | VeryLikelyInverse | DefinitelyInverse | MixedFirstName | MixedLastName > - Sets the name hint for the input name. Default of Varying means if necessary, statistical logic will be employed to determine name order, with no bias toward either name order.
  • SalutationFormat:< Formal | Informal | FirstLast > - Sets the salutation format for the response. Default of Formal Sets the salutation format to formal.
  • StandardizeCasing:< On | Off > - Determines whether to standardize casing in the email field before any checking occurs. Default of On will standardize all letters to lower case.
  • StandardizeCompany:< On | Off > - Determines whether to standardize the CompanyName field. Default of On will perform standard abbreviation, capitalization, and punctuation on the CompanyName field.
  • UpdateDomain:< On | Off > - Determines whether to update the domain name. Default of On will update the domain if it is out of date.
  • UsePreferredCity:< Off | On > - Determines whether to substitute the preferred city name for all vanity names when verifying an address. Default of Off means no substitution will occur.

Response

Successful response

TotalRecordsstring

Total number of records.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Personator Consumer Result Codes.

Versionstring

The current service version number.