Personator Identity:Response

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 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
Account Number		AccountNumber
Business Information		BusinessInformation
Results	Name	Results
Company		Company
Name prefix		NamePrefix
NameFirst		NameFirst
NameMiddle		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
SubPremises		SubPremises
DoubleDependentLocality		DoubleDependentLocality
DependentLocality		DependentLocality
Locality		Locality
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
DependentThoroughfarePostDirection		DependentThoroughfarePostDirection
Building		Building
PremisesType		PremisesType
PremisesNumber		PremisesNumber
SubPremisesType		SubPremisesType
SubPremisesNumber		SubPremisesNumber
PostBox		PostBox
Latitude		Latitude
Longitude		Longitude
Deliverability Confidence Score	Email	DeliverabilityConfidenceScore
Results		Results
Email address		EmailAddress
Mailbox name		MailboxName
Domain name		DomainName
Top level domain		TopLevelDomain
Top level domain name		TopLevelDomainName
Date checked		DateChecked
Email Age Estimated		EmailAgeEstimated
Domain Age Estimated		DomainAgeEstimated
Domain Expiration Date		DomainExpirationDate
Domain Created Date		DomainCreatedDate
Domain Updated Date		DomainUpdatedDate
Domain Email		DomainEmail
Domain Organization		DomainOrganization
Domain Address 1		DomainAddress1
Domain Locality		DomainLocality
Domain Administrative Area		DomainAdministrativeArea
Domain Postal Code		DomainPostalCode
Domain Country		DomainCountry
Domain Availability		DomainAvailability
Domain Country Code		DomainCountryCode
Domain Private Proxy		DomainPrivateProxy
Privacy Flag		PrivacyFlag
MX Server		MXServer
Breach Count		BreachCount
Results	Phone	Results
Phone Number		PhoneNumber
Administrative Area		AdministrativeArea
Country Abbreviation		CountryAbbreviation
Country Name		CountryName
Carrier		Carrier
Caller ID		CallerID
Daylight Savings Time		DST
International Phone Number		InternationalPhoneNumber
Language		Language
Latitude		Latitude
Locality		Locality
Longitude		Longitude
International Prefix		PhoneInternationalPrefix
Country Dialing Code		PhoneCountryDialingCode
Nation Prefix		PhoneNationPrefix
National Destination Code		PhoneNationalDestinationCode
Subscriber Number		PhoneSubscriberNumber
Universal Time Code		UTC
Postal Code		PostalCode
Suggestions		Suggestions

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

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

Protocol	Syntax
JSON	`"Results":"string"`

Version

This is a string value that is the current revision number of Personator Identity 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 Identity 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

An object with three fields.

For a list of used watchlists, see Personator Identity Watchlists.

Field	Meaning
Hit	Returns a string containing either `Yes` or `No`.
Sources	Returns an array of the names of watchlists the individual was found on.
Name	A string value containing the name of the Watchlist source that was matched.
Code	A two letter string representing the code attributed to the watchlist source. Premium Watchlist matches will always return `PR`.
Type	A string value containing the type or category of Watchlist that was matched against.
Date	A string value containing the date (`YYYY-MM-DD`) of when the Watchlist source was created. An empty string will be returned if the source does not have this information.
Articles	Returns the title, link and date of the article.

Protocol

Syntax

Example

JSON

"Watchlists": {

 "Hit":"string",
 "Sources":
   [{
     "Name":"string",
     "Code":"string",
     "Type":"string",
     "Date":"string"
   }]
 },
 "Articles":
   [{
     "Title":"string",
     "Link":"string",
     "Date":"string"
   }]
 }

"Watchlists": {

 "Hit":"Yes",
 "Sources":
   [{
     "Name":"Specially Designated Nationals OFAC",
     "Code":"",
     "Type":"sanction",
     "Date":""
   },
   {
     "Name":"United Kingdom HM Treasury",
     "Code": "PR",
     "Type": "sanction",
     "Date": "2005-12-07"
   }],
 "Articles":
   [{
     "Title":"SampleTitleName",
     "Link":"http://samplereportlink.com",
     "Date":"2017-09-30T00:00:00Z"
   }],
 }

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"`

AccountNumber

An object that returns one field for account number status.

Field	Meaning
Validated	Returns a string containing either `Y` or `N`.

Protocol	Syntax	Example
JSON	`"AccountNumber": {` `"Validated":"string" }`	`"AccountNumber": {` `"Validated":"Y" }`

BusinessInformation

An object that returns the following Business Information:

Field	Meaning
Name	Name of the business that matched
ID	Business ID. Uses the official business ID specific to the country: US: EIN SG: Unique Entity Number CA: Corporations Number or Business Number DE: German Trade Register or Handelsregister (HRB)
Status	The current status of the business. e.g. "Active".
Type	Business Type, e.g. "Corporation", "Limited Liability Company".
Date	Registration Date of the business, in the `YYYY-MM-DD` format.

Protocol	Syntax	Example
JSON	`"BusinessInformation": {` `"Name":"string", "ID":"string", "Status":"string", "Type":"string", "RegistrationDate":"string" }`	`"BusinessInformation": {` `"Name":"Melissa Data", "ID":"0123456", "Status":" ", "Type":"Corporation", "RegistrationDate":"1985-01-01" }`

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 Identity 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 Identity 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"`