Personator Identity:Request

From Melissa Data Wiki
Revision as of 00:18, 8 March 2017 by Admin (talk | contribs)
Jump to navigation Jump to search

← Personator Identity

Personator Identity Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
POST JSON
Result Codes
Result Code Use
Personator Identity Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and the fields listed as Required below.

The web service supports REST and JSON protocols.


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name REST JSON
Transmission Reference t TransmissionReference
Customer ID id CustomerID
Actions act Actions
Address options addrOpt AddressOptions
Name options nameOpt NameOptions
Email options emailOpt EmailOptions
Phone options phoneOpt PhoneOptions
Options opt Options
National ID nat NationalID
Full name full FullName
Company comp Company
Phone number phone PhoneNumber
Email email Email
Date of birth dob DateOfBirth
Address line 1 a1 AddressLine1
Address line 2 a2 AddressLine2
Address line 3 a3 AddressLine3
Address line 4 a4 AddressLine4
Address line 5 a5 AddressLine5
Address line 6 a6 AddressLine6
Address line 7 a7 AddressLine7
Address line 8 a8 AddressLine8
Locality loc Locality
Administrative area admarea AdministrativeArea
Postal code postal PostalCode
Country ctry Country
Country of origin ctryorg CountryOfOrigin


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"
REST ?t = string


Customer ID

Required.
This is a string value containing the License Key issued to the customer by Melissa Data for the web service.
If this element is absent, the web service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "CustomerID":"string"
REST &id = string


Actions

Required.
This field determines what actions the service will perform on the input data. These actions are available:
  • 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.

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


For every request, a Check action is always performed on the input.

Protocol Syntax
JSON "Actions":"string"
REST &act = string


Address Options

Optional.
This is a string value containing the address options set by the user when the address is being validated during the Check action.
Protocol Syntax
JSON "AddressOptions":"string"
REST &addrOpt = string


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


Name Options

Optional.
This is a string value containing the name options set by the user when the name is being validated during the Check action.
Protocol Syntax
JSON "NameOptions":"string"
REST &nameOpt = string


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


Email Options

Optional.
This is a string value containing the email options set by the user when the email is being validated during the Check action.
Protocol Syntax
JSON "EmailOptions":"string"
REST &emailOpt = string


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


Phone Options

Optional.
This is a string value containing the phone options set by the user when the phone is being validated during the Check action.
Protocol Syntax
JSON "PhoneOptions":"string"
REST &phoneOpt = string


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


Options

Optional.
This is a string value containing other mscellaneous options related to the web service. There are no other options currently available. This is reserved for future use.
Protocol Syntax
JSON "Options":"string"
REST &opt = string


National ID

Optional.
A string containing the national ID specific to the country. (e.g. in the US the Social Security Number)
Protocol Syntax
JSON "NationalID":"string"
REST &nat = string


Full Name

Recommended.
The full name to be genderized, standardized, and parsed.
Protocol Syntax
JSON "FullName":"string"
REST &full = string


Company

Optional.
The company/organization name to be standardized.
Protocol Syntax
JSON "Company":"string"
REST &comp = string


Phone Number

Optional.
The phone number to be verified.
Protocol Syntax
JSON "PhoneNumber":"string"
REST &phone = string


Email

Optional.
The email address to be verified.
Protocol Syntax
JSON "Email":"string"
REST &email = string


Date of Birth

Optional.
The date of birth to be verified. The expected input format is YYYYMMDD.
Protocol Syntax
JSON "DateOfBirth":"string"
REST &dob = string


Address Line 1

Required.
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.
Protocol Syntax
JSON "AddressLine1":"string"
REST &a1 = string


Address Line 2

Required.
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.
Protocol Syntax
JSON "AddressLine2":"string"
REST &a2 = string


Address Line 3

Required.
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.
Protocol Syntax
JSON "AddressLine3":"string"
REST &a3 = string


Address Line 4

Required.
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.
Protocol Syntax
JSON "AddressLine4":"string"
REST &a4 = string


Address Line 5

Required.
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.
Protocol Syntax
JSON "AddressLine5":"string"
REST &a5 = string


Address Line 6

Required.
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.
Protocol Syntax
JSON "AddressLine6":"string"
REST &a6 = string


Address Line 7

Required.
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.
Protocol Syntax
JSON "AddressLine7":"string"
REST &a7 = string


Address Line 8

Required.
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.
Protocol Syntax
JSON "AddressLine8":"string"
REST &a8 = string


Locality

Required.
The most common population center data element.
US Term: City
Canada Term: Municipality
Protocol Syntax
JSON "Locality":"string"
REST &loc = string


Administrative Area

Required.
The most common geographic data element.
US Term: State
Canada Term: Province
Protocol Syntax
JSON "AdministrativeArea":"string"
REST &admarea = string


PostalCode

Required.
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.
Protocol Syntax
JSON "PostalCode":"string"
REST &postal = string


Country

Required.
The country name, abbreviation, or code.
Protocol Syntax
JSON "Country":"string"
REST &ctry = string


Country of Origin

Optional.
This is used to determine whether or not to include the country name as the last line in the FormattedAddress field.
Protocol Syntax
JSON "CountryOfOrigin":"string"
REST &ctryOrg = string
Retrieved from "http://wiki.melissadata.com/index.php?title=Personator_Identity:Request&oldid=12618"