Personator Identity:Response

← Personator Identity

A response is the result of a request. This consists of returned result codes.

The web service returns back a response in a JSON format.

Field Names

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

Field Name	Level	JSON
Transaction ID	Response (Base)	TransactionID
Transmission Reference		TransmissionReference
Results		Results
Version		Version
Results	Identity	Results
Confidence		Confidence
Datasources		Datasources
Watchlists		Watchlists
Watchlist persons		WatchlistPersons
National ID		NationalID
Date of birth		DateOfBirth
Results	Name	Results
Company		Company
Name prefix		NamePrefix
First name		NameFirst
Middle name		NameMiddle
NameLast		NameLast
NameSuffix		NameSuffix
Gender		Gender
NamePrefix2		NamePrefix2
NameFirst2		NameFirst2
NameMiddle2		NameMiddle2
NameLast2		NameLast2
NameSuffix2		NameSuffix2
Gender2		Gender2
Results	Address	Results
FormattedAddress		FormattedAddress
Organization		Organization
AddressLine1		AddressLine1
AddressLine2		AddressLine2
AddressLine3		AddressLine3
AddressLine4		AddressLine4
AddressLine5		AddressLine5
AddressLine6		AddressLine6
AddressLine7		AddressLine7
AddressLine8		AddressLine8
DoubleDependentLocality		DoubleDependentLocality
SubAdministrativeArea		SubAdministrativeArea
AdministrativeArea		AdministrativeArea
PostalCode		PostalCode
AddressType		AddressType
AddressKey		AddressKey
SubNationalArea		SubNationalArea
CountryName		CountryName
CountryCode		CountryCode
CountryISO3		CountryISO3
CountryNumber		CountryNumber
CountrySubdivisionCode		CountrySubdivisionCode
Thoroughfare		Thoroughfare
ThoroughfarePreDirection		ThoroughfarePreDirection
ThoroughfareLeadingType		ThoroughfareLeadingType
ThoroughfareName		ThoroughfareName
ThoroughfareTrailingType		ThoroughfareTrailingType
ThoroughfarePostDirection		ThoroughfarePostDirection
DependentThoroughfare		DependentThoroughfare
DependentThoroughfarePreDirection		DependentThoroughfarePreDirection
DependentThoroughfareLeadingType		DependentThoroughfareLeadingType
DependentThoroughfareName		DependentThoroughfareName
DependentThoroughfareTrailingType		DependentThoroughfareTrailingType
Building		Building
PremisesType		PremisesType
PremisesNumber		PremisesNumber
SubPremisesType		SubPremisesType
SubPremisesNumber		SubPremisesNumber
PostBox		PostBox
Latitude		Latitude
Longitude		Longitude
Results	Email	Results
Email address		EmailAddress
Mailbox name		MailboxName
Domain name		DomainName
Top level domain		TopLevelDomain
Top level domain name		TopLevelDomainName
Date checked		DateChecked
Results	Phone	Results
Carrier		Carrier
Caller ID		CallerID
International phone number		InternationalPhoneNumber
Phone number		PhoneNumber
Phone international prefix		PhoneInternationalPrefix
Phone nation prefix		PhoneNationPrefix
Phone country dialing code		PhoneCountryDialingCode
Phone national destination code		PhoneNationalDestinationCode
Phone subscriber number		PhoneSubscriberNumber
Locality		Locality
Administrative area
Country name
Country abbreviation
DST
UTC
Language
Latitude
Longitude

Response Elements

The following fields are in the response.

Response (Base Level)

TransactionID

This is a string value that serves as a unique identifier for this record. A unique transaction ID is generated for every record handled by Personator World.

Protocol	Syntax
JSON	"TransactionID":"string"

TransmissionReference

This is a string value that serves as a unique identifier for this request. It is returned as sent in the request, allowing you to match the response to the request.

Protocol	Syntax
JSON	"TransmissionReference":"string"

Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.

For a complete list of error codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

Version

This is a string value that is the current revision number of Personator World web service.

Protocol	Syntax
JSON	"Version":"string"

Identity

Results

This is a string value that lists the ID verification codes (KV*).

For a complete list of ID verification codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

Confidence

This is a string value containing a value indicating how reliable the record is after performing ID verification.

The 3 possible values returned:

Value	Meaning
High	Passing or high quality score
Medium	Possible pass with multiple matching elements
Low	None or minimal match rate

Protocol	Syntax
JSON	"Confidence":"string"

Datasources

Contains an array of data sources where a match is found against the input. This field is only available when the Verify action is specified. Otherwise a null value is returned.

Field	Meaning
DatasourceName	A string value indicating the name/type of data source.
Results	A string value containing the KV* result codes, indicating how the input matched against this particular data source.
Messages	An array object, listing the meaning of each KV* result code for this data source.
Messages -> ResultCode	The particular KV* result code.
Messages -> Descripton	A string value containing the description/meaning of the KV* result code.

Protocol	Syntax
JSON	"Datasources": [ "DatasourceName":"", "Results": "", "Messages": [{ "ResultCode": "", "Description": "" }] ]

Watchlists

Blank (Currently reserved for future) – A string value containing the codes.

Protocol	Syntax
JSON	"Watchlists":"string"

WatchlistsPersons

Blank (Currently reserved for future) – A string value listing the potential names that were found matched on a watchlist.

Protocol	Syntax
JSON	"WatchlistPersons":"string"

NationalID

A string value containing the input national ID returned as is.

Protocol	Syntax
JSON	"NationalID":"string"

DateOfBirth

A string value containing the input date of birth returned as is.

Protocol	Syntax
JSON	"DateOfBirth":"string"

Name

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

Company

This is a string value of the standardized company name.

Protocol	Syntax
JSON	"Company":"string"

NamePrefix

This is a string value of the first prefix (such as “Mr.” or “Dr.”) from an inputted full name.

If the FullName input property contained a single name, the prefix, if any, will be returned here. If two names were passed, the first of the two prefixes will be returned by this property.

Protocol	Syntax
JSON	"NamePrefix":"string"

NameFirst

This is a string value of the first name from an inputted full name.

If the FullName input property contained a single name, the first name, if any, will be returned here. If two names were passed, the first of the two first names will be returned by this property.

Protocol	Syntax
JSON	"NameFirst":"string"

NameMiddle

This is a string value of the middle name from an inputted full name.

If the FullName input property contained a single name, the middle name, if any, will be returned here. If two names were passed, the first of the two middle names will be returned by this property.

Protocol	Syntax
JSON	"NameMiddle":"string"

NameLast

This is a string value of the last name from an inputted full name.

If the FullName input property contained a single name, the last name, if any, will be returned here. If two names were passed, the first of the two last names will be returned by this property.

Protocol	Syntax
JSON	"NameLast":"string"

NameSuffix

This is a string value of the first suffix (such as “Jr.” or “III”) from an inputted full name.

If the FullName input property contained a single name, the suffix, if any, will be returned here. If two names were passed, the first of the two suffixes will be returned by this property.

Protocol	Syntax
JSON	"NameSuffix":"string"

Gender

This is a one-character string value indicating the gender of the first name from the input.

Code	Description
M	Male
F	Female
U	Unknown first name or no first name present
N	A neutral first name

Protocol	Syntax
JSON	"Gender":"string"

NamePrefix2

This is a string value of the second prefix (such as “Mr.” or “Dr.”) from an inputted full name.

If the FullName input property contained multiple names, the second prefix will be returned here.

Protocol	Syntax
JSON	"NamePrefix2":"string"

NameFirst2

This is a string value of the second first name from an inputted full name.

If the FullName input property contained multiple names, the second first name will be returned here.

Protocol	Syntax
JSON	"NameFirst2":"string"

NameMiddle2

This is a string value of the second middle name from an inputted full name.

If the FullName input property contained multiple names, the second middle name, if any, will be returned here.

Protocol	Syntax
JSON	"NameMiddle2":"string"

NameLast2

This is a string value of the second last name from an inputted full name.

If the FullName input property contained multiple names, the second last name, if any, will be returned here.

Protocol	Syntax
JSON	"NameLast2":"string"

NameSuffix2

This is a string value of the second suffix (such as “Jr.” or “III”) from an inputted full name.

If the FullName input property contained multiple names, the second suffix, if any, will be returned here.

Protocol	Syntax
JSON	"NameSuffix2":"string"

Gender2

This is a one-character string value indicating the gender of the inputted full name.

If the FullName input property contained multiple names, the gender of the second name will be returned here.

Code	Description
M	Male
F	Female
U	Unknown first name or no first name present
N	A neutral first name

Protocol	Syntax
JSON	"Gender2":"string"

Address

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

FormattedAddress

This is a string value that is the address in the correct format for mailing from the country specified in the CountryOfOrigin element. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option. See LineSeparator for more information.

Protocol	Syntax
JSON	"FormattedAddress":"string"

Organization

This is a string value that matches the Organization request element. It is not modified or populated by the Cloud Service.

Protocol	Syntax
JSON	"Organization":"string"

AddressLine1

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine1":"string"

AddressLine2

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine2":"string"

AddressLine3

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine3":"string"

AddressLine4

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine4":"string"

AddressLine5

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine5":"string"

AddressLine6

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine6":"string"

AddressLine7

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine7":"string"

AddressLine8

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

Protocol	Syntax
JSON	"AddressLine8":"string"

SubPremises

This is a string value that is the parsed SubPremises from the AddressLine elements.

US Term: Suite

Protocol	Syntax
JSON	"SubPremises":"string"

DoubleDependentLocality

This is a string value that is the standardized contents of the DoubleDependentLocality element.

Protocol	Syntax
JSON	"DoubleDependentLocality":"string"

DependentLocality

This is a string value that is the standardized contents of the DependentLocality element.

Protocol	Syntax
JSON	"DependentLocality":"string"

Locality

This is a string value that is the standardized contents of the Locality element.

Protocol	Syntax
JSON	"Locality":"string"

SubAdministrativeArea

This is a string value that is the standardized contents of the SubAdministrativeArea element.

Protocol	Syntax
JSON	"SubAdministrativeArea":"string"

AdministrativeArea

This is a string value that is the standardized contents of the AdministrativeArea element.

Protocol	Syntax
JSON	"AdministrativeArea":"string"

PostalCode

This is a string value that is the standardized contents of the PostalCode element.

Protocol	Syntax
JSON	"PostalCode":"string"

Appended Address Record Elements

AddressType

This is an appended string value that returns a one-character code for the type of address coded. This element works only for US and Canadian addresses.

Protocol	Syntax
JSON	"AddressType":"string"

AddressKey

This is a string value that is a unique key for the address. Only for US and Canadian addresses.

The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.

Protocol	Syntax
JSON	"AddressKey":"string"

SubNationalArea

This is a string value that is the standardized contents of the SubNationalArea element.

Protocol	Syntax
JSON	"SubNationalArea":"string"

CountryName

This is a string value that is the standardized contents of the CountryName element.

Protocol	Syntax
JSON	"CountryName":"string"

CountryCode

This is a string value that is the parsed CountryCode element from the input.

For example:

Country	Code
United States	US
Canada	CA
Philippines	PH

Protocol	Syntax
JSON	"CountryCode":"string"

CountryISO3

This is a string value that is the parsed CountryISO3 element from the input.

For example:

Country	Code
United States	USA
Canada	CAN
Philippines	PHL

Protocol	Syntax
JSON	"CountryISO3":"string"

CountryNumber

This is a string value that is the parsed CountryNumber element from the input.

For example:

Country	Code
United States	840
Canada	124
Philippines	608

Protocol	Syntax
JSON	"CountryNumber":"string"

CountrySubdivisionCode

This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. Examples are: US-CA, CN-16, or AU-VIC.

Currently, this field is only populated for some countries. These countries are: AU, BR, CA, CN, CR, DM, GT, HN, NI, MX, SV, US.

Protocol	Syntax
JSON	"CountrySubdivisionCode":"string"

Thoroughfare

This is a string value that is the parsed Thoroughfare element from the input.

Protocol	Syntax
JSON	"Thoroughfare":"string"

ThoroughfarePreDirection

This is a string value that is the parsed ThoroughfarePreDirection element from the input.

Protocol	Syntax
JSON	"ThoroughfarePreDirection":"string"

ThoroughfareLeadingType

This is a string value that is the parsed ThoroughfareLeadingType element from the input.

Protocol	Syntax
JSON	"ThoroughfareLeadingType":"string"

ThoroughfareName

This is a string value that is the parsed ThoroughfareName element from the input.

Protocol	Syntax
JSON	"ThoroughfareName":"string"

ThoroughfareTrailingType

This is a string value that is the parsed ThoroughfareTrailingType element from the input.

Protocol	Syntax
JSON	"ThoroughfareTrailingType":"string"

ThoroughfarePostDirection

This is a string value that is the parsed ThoroughfarePostDirection element from the input.

Protocol	Syntax
JSON	"ThoroughfarePostDirection":"string"

DependentThoroughfare

This is a string value that is the parsed DependentThoroughfare element from the input.

Protocol	Syntax
JSON	"DependentThoroughfare":"string"

DependentThoroughfarePreDirection

This is a string value that is the parsed DependentThoroughfarePreDirection element from the input.

Protocol	Syntax
JSON	"DependentThoroughfarePreDirection":"string"

DependentThoroughfareLeadingType

This is a string value that is the parsed DependentThoroughfareLeadingType element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareLeadingType":"string"

DependentThoroughfareName

This is a string value that is the parsed DependentThoroughfareName element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareName":"string"

DependentThoroughfareTrailingType

This is a string value that is the parsed DependentThoroughfareTrailingType element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareTrailingType":"string"

DependentThoroughfarePostDirection

This is a string value that is the parsed DependentThoroughfarePostDirection element from the input.

Protocol	Syntax
JSON	"DependentThoroughfarePostDirection":"string"

Building

This is a string value that is the parsed Building element from the input.

Protocol	Syntax
JSON	"Building":"string"

PremisesType

This is a string value that is the parsed PremisesType element from the input.

Protocol	Syntax
JSON	"PremisesType":"string"

PremisesNumber

This is a string value that is the parsed PremisesNumber element from the input.

Protocol	Syntax
JSON	"PremisesNumber":"string"

SubPremisesType

This is a string value that is the parsed SubPremisesType element from the input.

Protocol	Syntax
JSON	"SubPremisesType":"string"

SubPremisesNumber

This is a string value that is the parsed SubPremisesNumber element from the input.

Protocol	Syntax
JSON	"SubPremisesNumber":"string"

PostBox

This is a string value that is the parsed PostBox element from the input.

Protocol	Syntax
JSON	"PostBox":"string"

Latitude

This is a string value that is the parsed Latitude element from the input.

Protocol	Syntax
JSON	"Latitude":"string"

Longitude

This is a string value that is the parsed Longitude element from the input.

Protocol	Syntax
JSON	"Longitude":"string"

Email

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

Email Address

This is a string value listing the email address, including any corrections or changes made by Global Email.

Protocol	Syntax
JSON	"EmailAddress":"string"

Mailbox Name

This is a string value listing the mailbox or user name portion of the email address (All characters preceding the "@" character).

With an example email of "sample@melissadata.com" the mailbox name would be "sample".

Protocol	Syntax
JSON	"MailboxName":"string"

Domain Name

This is a string value listing the domain name portion of the email address (All characters between the "@" and "." characters).

With an example email of "sample@melissadata.com" the domain name would be "melissadata".

Protocol	Syntax
JSON	"DomainName":"string"

Top Level Domain

This is a string value listing the description associated with the top-level domain name of the email address.

Protocol	Syntax
JSON	"Top Level Domain":"string"

Top Level Domain Name

This is a string value listing the top level domain name portion of the email address (All characters after the ".").

With an example email of "sample@melissadata.com" the top level domain name would be "com".

Protocol	Syntax
JSON	"TopLevelDomainName":"string"

Date Checked

This is a string value listing the date the email was last checked. DateChecked field returns a UTC, Unix Time (Epoch Time).

Protocol	Syntax
JSON	"DateChecked":"string"

Phone

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see Personator World Result Codes.

Protocol	Syntax
JSON	"Results":"string"

Phone Number

This is a string value of the standardized phone number after a successful call to the service.

The phone number will return in varying formats depending on the inputs. If the inputted country and country of origin are the same the returned number will include the National Destination Code + Subscriber Number. For example:

Input Phone	Input Country	Input Country of Origin	Phone Returned
495-728-5802	RU	RU	495-728-5802
+7 495-728-5802	RU	RU	495-728-5802
+1 495-728-5802	RU	RU	495-728-5802

If the inputted country and country of origin differ, the returned number will include a leading ‘+’ followed by the Country Code + National Destination Code + Subscriber Number. The leading ‘+’ represents the International Prefix that is required to dial a number outside of the caller’s country. For example:

Input Phone	Input Country	Input Country of Origin	Phone Returned
495-728-5802	RU	US	+7 495-728-5802
+7 495-728-5802	RU	US	+7 495-728-5802
+1 495-728-5802	RU	US	+7 495-728-5802

If a country is entered and a country of origin is left blank or not passed in, the returned number will match the format of the inputted phone number. For example:

Input Phone	Input Country	Input Country of Origin	Phone Returned
495-728-5802	RU	<blank>	495-728-5802
+7 495-728-5802	RU	<blank>	+7 495-728-5802
+1 495-728-5802	RU	<blank>	+7 495-728-5802

Protocol	Syntax
JSON	"PhoneNumber":"string"

Administrative Area

This is a string that returns the administrative area associated with the inputted phone number.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"AdministrativeArea":"string"

Country Abbreviation

This is a string that returns the abbreviation of the country for the inputted phone number.

Protocol	Syntax
JSON	"CountryAbbreviation":"string"

Country Name

This is a string that returns the name of the country for the inputted phone number.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"CountryName":"string"

Carrier

This is a string that returns the name of the phone’s carrier.

Protocol	Syntax
JSON	"Carrier":"string"

Caller ID

This is the result from our CallerID service, which it appends the name to the targeted phone number.

Protocol	Syntax
JSON	"CallerID":"string"

Daylight Savings Time

This is a string that returns a ‘Y’ (for yes) or ‘N’ (for no) to distinguish whether the region of the inputted phone number observes daylight savings time.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"DST":"string"

International Phone Number

This is the number you would dial, given your output fields, in order to successfully send a call.

This number can change based on whether a Country of Origin is submitted or not.

Protocol	Syntax
JSON	"InternationalPhoneNumber":"string"

Language

This is a string that returns the predominant language of the phone’s detected geographical location.

The field will return the written out form of the language name. For example: "French".

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"Language":"string"

Latitude

This is a string that returns the latitude of the geographically identifiable service area of the exchange.

Latitude is the geographic coordinate of the locale, city, municipality, or other geographically identifiable service area of the exchange measured in degrees north or south of the equator.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"Latitude":"string"

Locality

This is a string that returns the locality (city) associated with the phone number passed to the Lookup function.

Because of phone portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"Locality":"string"

Longitude

This is a string that returns the longitude of the geographically identifiable service area of the exchange.

Longitude is the geographic coordinate of the locale, city, municipality, or other geographically identifiable service area of the exchange measured in degrees east or west of the Greenwich Meridian.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"Longitude":"string"

International Prefix

This is a string value that returns the international exit code needed to call a number outside of the dialing country.

If the input country and country of origin differ, this will return the digit(s) required to be dialed before the country code.

Protocol	Syntax
JSON	"PhoneInternationalPrefix":"string"

Country Dialing Code

This is a string that returns a digit, or combination of digits, known as the country dialing code.

This will return the digit(s) dialed after the international prefix.

Protocol	Syntax
JSON	"PhoneCountryDialingCode":"string"

Nation Prefix

This is a string that returns a digit, or combination of digits, known as the national prefix.

The national prefix must be dialed before an area (city) code when calling a number within the same country but outside the numbering area.

For example (US phone number): 1-949-589-5200 where 1 is the national prefix.

Protocol	Syntax
JSON	"PhoneNationPrefix":"string"

National Destination Code

This is a string that returns a digit, or combination of digits, known as the national destination code.

The national destination code that identifies a numbering area within a country (or group of countries) and/or network/services.

Protocol	Syntax
JSON	"PhoneNationalDestinationCode":"string"

Subscriber Number

This is string that returns the subscriber number associated with the phone number passed in.

The subscriber number contains significant leading digits that further define the local exchange area and/or service.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"PhoneSubscriberNumber":"string"

Universal Time Code

This is a string that returns the universal time code for the time zone associated with the inputted phone number.

UTC returns the time zone specified with the format: +/- hh:mm.

Because of phone number portability, geographical information may not reflect the true location of the owner of the phone number for wireless and VOIP numbers.

Protocol	Syntax
JSON	"UTC":"string"

Postal Code

The zip code that corresponds to a locality inside the United States.

Since this is US only, all other countries will have PostalCode blank.

Protocol	Syntax
JSON	"PostalCode":"string"

Suggestions

This is an array of Response Record Elements. This can only be returned for single-record requests.

Protocol	Syntax
JSON	"Suggestions":"string"