Verify an identity

The actions the service will perform on input data. For every request, a Check action is always performed on the input.

• Check: Determines whether the data within a submitted record is valid, e.g. whether or not a given postal code contains the given city. It can also make limited corrections and appends to the data. Check looks at each data point separately.
• Screen: Screens the provided input against various government sanctions and watchlists and returns back a list of matches. For a list of used watchlists, see Personator Identity Watchlists.
• Verify: After the data has been checked, identity verification is performed and result codes (KV*) are returned to indicate what pieces of input data have been matched against trusted referenced data.

Required. The License Key issued by Melissa.

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

Address Options - To be set when an address is being validated during the Check action.

List options in the following format, with multiple options delimited with a comma ,.

For example: OptionName:Parameter,OptionName:Parameter.

• CountryOfOrigin:< ISO2, ISO3, or ISO# > - This is used to determine whether or not to include the country name as the last line in FormattedAddress.
• DeliveryLines:< On | Off > - This options allows you to specify if the Address Lines 1-8 should contain just the delivery address or the entire address. Default of 'Off' will return the entire address.
• LineSeparator:< SEMICOLON | PIPE | CR | LF | CRLF | TAB | BR > - This is the line separator used for the FormattedAddress result. Default of SEMICOLON will use a semicolon ;.
• OutputScript:< NOCHANGE | LATIN | NATIVE > - This is the script type used for all applicable fields. Default of NOCHANGE will return the same script that is sent in.

Email Options - To be set when an email is being validated during the Check action.

List options in the following format, with multiple options delimited with a comma ,.

For example: OptionName:Parameter,OptionName:Parameter.

• DomainCorrection:< On | Off > - Default of On activates fuzzy email domain correction if the domain is a suspected typo.
• TimeToWait:< #[5 - 45] > - TimeToWait allows you to select how long (in seconds) that you would like our Cloud API to wait on a single email before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results. Defaults to 25.
• VerifyMailBox:< Express | Premium > - Default of Express quickly validates against database of known email addresses. Premium has a real time check performed to determine email deliverability.

Name Options - To be set when a name is being validated during the Check action.

• 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 can be used to set the action. List options in the following format, with multiple options delimited with a comma ,.

For example: OptionName:Parameter,OptionName:Parameter.

• CorrectFirstName:< ON | OFF > - This option enables or disables spelling correction of first names. Default of OFF preserves first name spellings; no correction allowed.

• GenderAggression:< Code or Name > - This option sets how aggressively the service will attempt to genderize neutral first names.

  • 1 or Aggressive -Aggressive name genderizing.
  • 2 or Neutral - Default. Neutral name genderizing.
  • 3 or Conservative - Conservative name genderizing.

• GenderPopulation:< Code or Name > - This option sets the gender balance of the source data, predominantly male, predominantly female, or neutral.

  • 1 or Male - Bias towards Male.
  • 2 or Mixed - Default. No bias towards either gender.
  • 3 or Female - Bias towards Female.

• 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.

  • 1 or DefinitelyFull - Name will always be treated as normal name order regardless of formatting or punctuation.
  • 4 or Varying - Default. Name will be treated as normal name order unless formatting or punctuation indicates otherwise.
  • 7 or DefinitelyInverse - Name will always be treated as inverse name order regardless of formatting or punctuation.

Options - Pass in options you want to set for the request.

List options in the following format, with multiple options delimited with a comma ,.

For example: OptionName:Parameter,OptionName:Parameter.

• Consent:< No | Yes > - This option is for data sources that require consent to be given - acknowledging that consent is given to allow the data to be verified by external data sources. Default of No indicates that no consent was given.

Phone Options - To be set when a phone number is being validated during the Check action.

List options in the following format, with multiple options delimited with a comma ,.

For example: OptionName:Parameter,OptionName:Parameter.

• CallerID:< True | False > - US and Canada Only. Default of False turns CallerID off.
• DefaultCallingCode:< [Country Calling Code] > - This is used when the country could not be detected from the phone number or country input. The default of a blank field will check the sequence of digits found after the leading +.
• TimeToWait:< #[1 - 30] > - TimeToWait allows you to select how long (in seconds) that you would like our Cloud API to wait on a single request before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results. Default set to 2.
• VerifyPhone:< Express | Premium > - This sets the level of verification to be done on a phone check. Default of Express will validate against a database of known phone numbers.

Privacy - This Option allows data elements to be redacted from the response. The user can submit any combination of data elements to redact, or all elements. All result codes will be returned to the client will be returned to the user.

List options in the following format, with multiple options delimited with a comma ,.

For example: Privacy:value1,value2,value3.

• Privacy:< [None] | name | address | phone | email | all > - Default of [None] will return all data elements.

Account Number - The input field for account number. This should contain an IBAN or SWIFT number.

Required. Address Line 1 - The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

Address Line 2 - The input field for the address.

Address Line 3 - The input field for the address.

Address Line 4 - The input field for the address.

Address Line 5 - The input field for the address.

Address Line 6 - The input field for the address.

Address Line 7 - The input field for the address.

Address Line 8 - The input field for the address.

Required. Administrative Area - State, Province. The most common geographic data element.

Company - The company/organization name to be standardized.

Required. Country - The country name, abbreviation, or code.

Country of Origin - This is used to determine whether or not to include the country name as the last line in the FormattedAddress field.

Date of Birth - The date of birth to be verified. The expected input format is YYYYMMDD.

Email - The email address to be verified.

First Name - The given (first) name for the individual.

Full Name - The full name to be genderized, standardized, and parsed. This will only be done if the first name and last name fields are left blank.

Last Name - The family (last) name or surname for the individual.

Required. Locality - City, Municipality. The most common population center data element.

National ID - Social Security Number. The national ID specific to the country.

Phone Number - The phone number to be verified.

Required. Postal Code - ZIP, Postcode. The complete postal code for a particular delivery point. If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

Format of the response.

Format of the request.