Personator Search:Response

← Personator Search

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
Results	Response (Base)	Results
Transmission Results		TransmissionResults
Transmission Reference		TransmissionReference
Total Pages		TotalPages
Total Records		TotalRecords
Version		Version
Record ID	Record	RecordID
Results		Results
Full Name		FullName
First Name		FirstName
Last Name		LastName
Date of Birth		DateOfBirth
Date of Death		DateOfDeath
Current Address		CurrentAddress
Previous Address Records		PreviousAddressRecords
Phone Records		PhoneRecords
Email Records		EmailRecords
Address Line 1	CurrentAddress	AddressLine1
Suite		Suite
City		City
State		State
Postal Code		PostalCode
Plus4		Plus4
Melissa Address Key		MelissaAddressKey
Melissa Address Key Base		MelissaAddressKeyBase
Move Date		MoveDate
Address Line 1	PreviousAddressRecords	AddressLine1
Suite		Suite
City		City
State		State
Postal Code		PostalCode
Plus4		Plus4
Melissa Address Key		MelissaAddressKey
Melissa Address Key Base		MelissaAddressKeyBase
Move Date		MoveDate
Phone	PhoneRecords	Phone
Email	EmailRecords	Email

Response Elements

The following fields are in the response.

Response (Base Level)

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 Search Result Codes.

Protocol	Syntax
JSON	"Results":"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"

Version

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

Protocol	Syntax
JSON	"Version":"string"

Record

Results

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

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

Protocol	Syntax
JSON	"Results":"string"

DateOfBirth

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

Protocol	Syntax
JSON	"DateOfBirth":"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"

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"

CurrentAddress

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 Search Result Codes.

Protocol	Syntax
JSON	"Results":"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"

PostalCode

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

Protocol	Syntax
JSON	"PostalCode":"string"

PhoneRecords

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"

EmailRecords

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"