Personator Identity

Introduction

Personator™ Identity cloud service is a single web service that checks and verifies your client/contact data globally. An individual’s data can easily be verified against trusted reference data.

These data verification points include:

• Name

• Address

• Phone

• Email

• Date of Birth

• National ID

Click here to learn more about the Personator Identity Cloud API.

Licensing

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Personator Identity will not function.

Initialization

There are two different constructors that you can utilize when initializing Personator Identity.

PersonatorIdentity(string license)

Initialize the Cloud API object with a license key

Note

MELISSA_LICENSE_KEY is replaced with your license.

Get your license key here

• C#
• Python

PersonatorIdentity personatorIdentity = new PersonatorIdentity(MELISSA_LICENSE_KEY);

personator_identity = PersonatorIdentity(MELISSA_LICENSE_KEY)

PersonatorIdentity()

Initialize the Cloud API object, which will read the license key from the environment variable MD_LICENSE or configured using a set method

Click here to learn more about setting up the environment variable.

• C#
• Python

PersonatorIdentity personatorIdentity = new PersonatorIdentity()

personator_identity = PersonatorIdentity()

Configuration

Personator Identity supports both GET and POST requests.

• (GET) Using one of three ways to configure each respective parameter

• (POST) Using the Set Post Body Method to pass a PersonatorIdentityPostRequest object as the pre-constructed post body containing all parameters and records to process

Requests

GET

To send a GET request, there are three ways you can configure the parameters to make a request.

• Method 1: Using the Set Value Method to specify the parameter and value you want to set it to

• Method 2: Using direct property access to set parameter values

• Method 3: Using specialized Set Methods to set parameter values

Method 1: Using Set Value Method

This function allows you to specify input parameters and the values you went to set them to.

Format

Note

Replace ACTION, FULL_NAME, ADDRESS_LINE_1, LOCALITY, ADMINISTRATIVE_AREA, POSTAL_CODE, and COUNTRY with variables or values.

• C#
• Python

personatorIdentity.SetValue("Action", ACTION);
personatorIdentity.SetValue("FullName", FULL_NAME);
personatorIdentity.SetValue("AddressLine1", ADDRESS_LINE_1);
personatorIdentity.SetValue("Locality", LOCALITY);
personatorIdentity.SetValue("AdministrativeArea", ADMINISTRATIVE_AREA);
personatorIdentity.SetValue("Postal", POSTAL_CODE);
personatorIdentity.SetValue("Country", COUNTRY);

personator_identity.set_value("action", ACTION)
personator_identity.set_value("full_name", FULL_NAME)
personator_identity.set_value("address_line1", ADDRESS_LINE_1)
personator_identity.set_value("locality", LOCALITY)
personator_identity.set_value("administrative_area", ADMINISTRATIVE_AREA)
personator_identity.set_value("postal", POSTAL_CODE)
personator_identity.set_value("country", COUNTRY)

Example

• C#
• Python

personatorIdentity.SetValue("Action", "check");
personatorIdentity.SetValue("FullName", "Raymond Melissa");
personatorIdentity.SetValue("AddressLine1", "22382 Avenida Empresa");
personatorIdentity.SetValue("Locality", "Rancho Santa Margarita");
personatorIdentity.SetValue("AdministrativeArea", "CA");
personatorIdentity.SetValue("Postal", "92688");
personatorIdentity.SetValue("Country", "United States");

personator_identity.set_value("action", "check")
personator_identity.set_value("full_name", "Raymond Melissa")
personator_identity.set_value("address_line1", "22382 Avenida Empresa")
personator_identity.set_value("locality", "Rancho Santa Margarita")
personator_identity.set_value("administrative_area", "CA")
personator_identity.set_value("postal", "92688")
personator_identity.set_value("country", "United States")

Method 2: Using Direct Property Access

This allows you to set values directly using the Cloud API’s parameter names.

Format

Note

Replace ACTION, FULL_NAME, ADDRESS_LINE_1, LOCALITY, ADMINISTRATIVE_AREA, POSTAL_CODE, and COUNTRY with variables or values.

• C#
• Python

personatorIdentity.Action = ACTION;
personatorIdentity.FullName = FULL_NAME;
personatorIdentity.AddressLine1 = ADDRESS_LINE_1;
personatorIdentity.Locality = LOCALITY;
personatorIdentity.AdministrativeArea = ADMINISTRATIVE_AREA;
personatorIdentity.Postal = POSTAL_CODE;
personatorIdentity.Country = COUNTRY;

personator_identity.action = ACTION
personator_identity.full_name = FULL_NAME
personator_identity.address_line1 = ADDRESS_LINE_1
personator_identity.locality = LOCALITY
personator_identity.administrative_area = ADMINISTRATIVE_AREA
personator_identity.postal = POSTAL_CODE
personator_identity.country = COUNTRY

Example

• C#
• Python

personatorIdentity.Action = "check";
personatorIdentity.FullName = "Raymond Melissa";
personatorIdentity.AddressLine1 = "22382 Avenida Empresa";
personatorIdentity.Locality = "Rancho Santa Margarita";
personatorIdentity.AdministrativeArea = "Ca";
personatorIdentity.Postal = "92688";
personatorIdentity.Country = "United States";

personator_identity.action = "check"
personator_identity.full_name = "Raymond Melissa"
personator_identity.address_line1 = "22382 Avenida Empresa"
personator_identity.locality = "Rancho Santa Margarita"
personator_identity.administrative_area = "Ca"
personator_identity.postal = "92688"
personator_identity.country = "United States"

Method 3: Using Specialized Methods

These functions allow you to set the input parameters for the Cloud API.

See Set Methods for a list of available parameters.

Format

Note

Replace ACTION, FULL_NAME, ADDRESS_LINE_1, LOCALITY, ADMINISTRATIVE_AREA, POSTAL_CODE, and COUNTRY with variables or values.

• C#
• Python

personatorIdentity.SetAction(ACTION);
personatorIdentity.SetFullName(FULL_NAME);
personatorIdentity.SetAddressLine1(ADDRESS_LINE_1);
personatorIdentity.SetLocality(LOCALITY);
personatorIdentity.SetAdministrativeArea(ADMINISTRATIVE_AREA);
personatorIdentity.SetPostal(POSTAL_CODE);
personatorIdentity.SetCountry(COUNTRY);

personator_identity.set_action(ACTION)
personator_identity.set_full_name(FULL_NAME)
personator_identity.set_address_line1(ADDRESS_LINE_1)
personator_identity.set_locality(LOCALITY)
personator_identity.set_administrative_area(ADMINISTRATIVE_AREA)
personator_identity.set_postal(POSTAL_CODE)
personator_identity.set_country(COUNTRY)

Example

• C#
• Python

personatorIdentity.SetAction("check");
personatorIdentity.SetFullName("Raymond Melissa");
personatorIdentity.SetAddressLine1("22382 Avenida Empresa");
personatorIdentity.SetLocality("Rancho Santa Margarita");
personatorIdentity.SetAdministrativeArea("CA");
personatorIdentity.SetPostal("92688");
personatorIdentity.SetCountry("United States");

personator_identity.set_action("check")
personator_identity.set_full_name("Raymond Melissa")
personator_identity.set_address_line1("22382 Avenida Empresa")
personator_identity.set_locality("Rancho Santa Margarita")
personator_identity.set_administrative_area("CA")
personator_identity.set_postal("92688")
personator_identity.set_country("United States")

POST

To send a POST request, there is one way you can configure the parameters to make a request.

• Method 1: Using the Set Post Body Method to pass a PersonatorIdentityPostRequest object as the pre-constructed post body containing all parameters and records to process

Method 1: Set Post Body

This function allows you to pass a pre-constructed post body with all parameters and records for POST requests.

Format

Note

Replace MELISSA_LICENSE_KEY, ACTION, FULL_NAME, ADDRESS_LINE_1, LOCALITY, ADMINISTRATIVE_AREA, POSTAL_CODE, and COUNTRY with variables or values.

Get your license key here

• C#
• Python

personatorIdentity.SetPostBody(new PersonatorIdentityRecordRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  Actions = ACTION,
  FullName = FULL_NAME,
  AddressLine1 = ADDRESS_LINE_1,
  Locality = LOCALITY,
  AdministrativeArea = ADMINISTRATIVE_AREA,
  PostalCode = POSTAL_CODE,
  Country = COUNTRY
});

personator_identity.set_post_body(PersonatorIdentityRecordRequest(
  customer_id = MELISSA_LICENSE_KEY,
  actions = ACTION,
  full_name = FULL_NAME,
  address_line1 = ADDRESS_LINE_1,
  locality = LOCALITY,
  administrative_area = ADMINISTRATIVE_AREA,
  postal_code = POSTAL_CODE,
  country = COUNTRY
))

Example

Note

MELISSA_LICENSE_KEY is replaced with your license.

Get your license key here

• C#
• Python

personatorIdentity.SetPostBody(new PersonatorIdentityRecordRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  Actions = "check",
  FullName = "Raymond Melissa",
  AddressLine1 = "22382 Avenida Empresa",
  Locality = "Rancho Santa Margarita",
  AdministrativeArea = "CA",
  PostalCode = "92688",
  Country = "United States"
});

personator_identity.set_post_body(PersonatorIdentityRecordRequest(
  customer_id = MELISSA_LICENSE_KEY,
  actions = "check",
  full_name = "Raymond Melissa",
  address_line1 = "22382 Avenida Empresa",
  locality = "Rancho Santa Margarita",
  administrative_area = "CA",
  postal_code = "92688",
  country = "United States"
))

Response

When submitting a request, you have the option to either get the response as a string or encapsulate the response into the respective Cloud API response object.

As a String

Submit a GET or POST request and get the response as a string.

• C#
• Python

string response = personator.Get<string>();

response = personator.get(str)

• C#
• Python

string response = personator.Post<string>();

response = personator.post(str)

As a Response Object

Submit a GET or POST request and encapsulate the response into the Cloud API response object.

• C#
• Python

PersonatorIdentityResponse responseObject = personator.Get<PersonatorIdentityResponse>();

response_object = personator.get(PersonatorIdentityResponse)

• C#
• Python

PersonatorIdentityResponse responseObject = personator.Post<PersonatorIdentityResponse>();

response_object = personator.post(PersonatorIdentityResponse)

Accessing Values

When encapsulating the response into the Cloud API’s respective response object, there are three ways to access values. The response object structure matches the respective Cloud API’s response format.

Click here to learn more about the Global Address Verification response format.

The record responses are typically stored in a list. In the examples below, record represents an individual record at an arbitrary position within this list.

1. Using the Get Value Method:

Pass the field name as a string to the Get Value Method, and it will return the corresponding field value.

• C#
• Python

record.GetValue("RecordID");
record.GetValue("Results");

record.get_value("RecordID")
record.get_value("Results")

2. Accessing Properties directly

Values can be accessed directly using the response object’s field names.

• C#
• Python

record.RecordID;
record.Results;

record.record_id
record.results

3. Use Specialized Methods

Use get methods corresponding to field name to get the field value.

• C#
• Python

record.GetRecordID();
record.GetResults();

record.get_record_id()
record.get_results()

Methods

The methods listed below pertain to the Personator Identity Cloud API object.

For methods related to the respective Cloud API’s response object click here.

Constructors

These methods initialize and configure instances of the Cloud API object. Use these methods to create a new object, optionally providing initial values such as a license string to customize the instance during its creation.

• C#
• Python

Method	Description
PersonatorIdentity()	Constructor to initialize the Personator Identity object.
PersonatorIdentity(string license)	Constructor to initialize the Personator Identity object with a license string.

Method	Description
PersonatorIdentity()	Constructor to initialize the Personator Identity object.
PersonatorIdentity(license)	Constructor to initialize the Personator Identity object with a license string.

Set Methods

These methods configure or modify parameters at the record level for the Cloud API object. Use these methods to make adjustments to the parameters during the execution of the Cloud API, ensuring flexibility in customizing API requests.

• C#
• Python

Method	Description
void SetBaseUrl(string baseUrl)	Set the base URL.
void SetLicense(string license)	Set the license string.
void SetEndpoint(string endpoint)	Set the endpoint.
void SetFormat(string format)	Set the format.
void SetAction(string action)	Set the action.
void SetNationalID(string nationalId)	Set the national ID.
void SetFirstName(string firstName)	Set the first name.
void SetLastName(string lastName)	Set the last name.
void SetFullName(string fullName)	Set the full name.
void SetCompany(string company)	Set the company.
void SetPhone(string phone)	Set the phone number.
void SetEmail(string email)	Set the email.
void SetDOB(string dob)	Set the date of birth.
void SetAccountNumber(string accountNumber)	Set the account number.
void SetAddressLine1(string addressLine1)	Set the address line 1.
void SetAddressLine2(string addressLine2)	Set the address line 2.
void SetAddressLine3(string addressLine3)	Set the address line 3.
void SetAddressLine4(string addressLine4)	Set the address line 4.
void SetAddressLine5(string addressLine5)	Set the address line 5.
void SetAddressLine6(string addressLine6)	Set the address line 6.
void SetAddressLine7(string addressLine7)	Set the address line 7.
void SetAddressLine8(string addressLine8)	Set the address line 8.
void SetLocality(string locality)	Set the locality.
void SetAdministrativeArea(string administrativeArea)	Set the administrative area.
void SetPostal(string postal)	Set the postal code.
void SetCountry(string country)	Set the country.
void SetCountryOrigin(string countryOrigin)	Set the country of origin.
void SetTransmissionReference(string transmissionReference)	Set the transmission reference.
void SetAddressOpt(string addressOpt)	Set the address option.
void SetNameOpt(string nameOpt)	Set the name option.
void SetEmailOpt(string emailOpt)	Set the email option.
void SetPhoneOpt(string phoneOpt)	Set the phone option.
void SetOpt(string opt)	Set the option.
void SetPrivacy(string privacy)	Set the privacy.
void SetValue(string parameter, string value)	Set the input parameter to a specified value.
void SetPostBody(PersonatorIdentityRecordRequest postBody)	Set the post body for post requests.

Method	Description
set_base_url(base_url)	Set the base URL.
set_license(license)	Set the license string.
set_endpoint(endpoint)	Set the endpoint.
set_format(format)	Set the format.
set_action(action)	Set the action.
set_national_id(national_id)	Set the national ID.
set_first_name(first_name)	Set the first name.
set_last_name(last_name)	Set the last name.
set_full_name(full_name)	Set the full name.
set_company(company)	Set the company.
set_phone(phone)	Set the phone number.
set_email(email)	Set the email.
set_dob(dob)	Set the date of birth.
set_account_number(account_number)	Set the account number.
set_address_line1(address_line1)	Set the address line 1.
set_address_line2(address_line2)	Set the address line 2.
set_address_line3(address_line3)	Set the address line 3.
set_address_line4(address_line4)	Set the address line 4.
set_address_line5(address_line5)	Set the address line 5.
set_address_line6(address_line6)	Set the address line 6.
set_address_line7(address_line7)	Set the address line 7.
set_address_line8(address_line8)	Set the address line 8.
set_locality(locality)	Set the locality.
set_administrative_area(administrative_area)	Set the administrative area.
set_postal(postal)	Set the postal code.
set_country(country)	Set the country.
set_country_origin(country_origin)	Set the country of origin.
set_transmission_reference(transmission_reference)	Set the transmission reference.
set_address_opt(address_opt)	Set the address option.
set_name_opt(name_opt)	Set the name option.
set_email_opt(email_opt)	Set the email option.
set_phone_opt(phone_opt)	Set the phone option.
set_opt(opt)	Set the option.
set_privacy(privacy)	Set the privacy.
set_value(parameter, value)	Set the input parameter to a specified value.
set_post_body(post_body)	Set the post body for post requests.

Get Methods

These methods retrieve parameter values from the Cloud API object. Use these methods to access the parameters configured for the Cloud API at the record level, providing insight into the current state of the object’s settings.

• C#
• Python

Method	Description
string GetBaseUrl()	Get the base URL.
string GetLicense()	Get the license string.
string GetEndpoint()	Get the endpoint.
string GetFormat()	Get the format.
string GetAction()	Get the action.
string GetNationalID()	Get the national ID.
string GetFirstName()	Get the first name.
string GetLastName()	Get the last name.
string GetFullName()	Get the full name.
string GetCompany()	Get the company.
string GetPhone()	Get the phone number.
string GetEmail()	Get the email.
string GetDOB()	Get the date of birth.
string GetAccountNumber()	Get the account number.
string GetAddressLine1()	Get the address line 1.
string GetAddressLine2()	Get the address line 2.
string GetAddressLine3()	Get the address line 3.
string GetAddressLine4()	Get the address line 4.
string GetAddressLine5()	Get the address line 5.
string GetAddressLine6()	Get the address line 6.
string GetAddressLine7()	Get the address line 7.
string GetAddressLine8()	Get the address line 8.
string GetLocality()	Get the locality.
string GetAdministrativeArea()	Get the administrative area.
string GetPostal()	Get the postal code.
string GetCountry()	Get the country.
string GetCountryOrigin()	Get the country of origin.
string GetTransmissionReference()	Get the transmission reference.
string GetAddressOpt()	Get the address option.
string GetNameOpt()	Get the name option.
string GetEmailOpt()	Get the email option.
string GetPhoneOpt()	Get the phone option.
string GetOpt()	Get the option.
string GetPrivacy()	Get the privacy.
PersonatorIdentityRecordRequest GetPostBody()	Get the post body for post requests.

Method	Description
get_base_url()	Get the base URL.
get_license()	Get the license string.
get_endpoint()	Get the endpoint.
get_format()	Get the format.
get_action()	Get the action.
get_national_id()	Get the national ID.
get_first_name()	Get the first name.
get_last_name()	Get the last name.
get_full_name()	Get the full name.
get_company()	Get the company.
get_phone()	Get the phone number.
get_email()	Get the email.
get_dob()	Get the date of birth.
get_account_number()	Get the account number.
get_address_line1()	Get the address line 1.
get_address_line2()	Get the address line 2.
get_address_line3()	Get the address line 3.
get_address_line4()	Get the address line 4.
get_address_line5()	Get the address line 5.
get_address_line6()	Get the address line 6.
get_address_line7()	Get the address line 7.
get_address_line8()	Get the address line 8.
get_locality()	Get the locality.
get_administrative_area()	Get the administrative area.
get_postal()	Get the postal code.
get_country()	Get the country.
get_country_origin()	Get the country of origin.
get_transmission_reference()	Get the transmission reference.
get_address_opt()	Get the address option.
get_name_opt()	Get the name option.
get_email_opt()	Get the email option.
get_phone_opt()	Get the phone option.
get_opt()	Get the option.
get_privacy()	Get the privacy.
get_post_body()	Get the post body for post requests.

Class Methods

These methods perform service-level operations, handling the core processing and interactions for the Cloud API object. Use these methods to execute primary functionalities such as assembling records, clearing records, and making API requests.

• C#
• Python

Method	Description
T Get<T>()	Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
async Task<T> GetAsync<T>()	Makes the asynchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
T Post<T>()	Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
async Task<T> PostAsync<T>()	Makes asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
string GetApiVersion()	Makes synchronous getversion request and returns parsed Cloud API version.
async Task<string> GetApiVersionAsync()	Makes asynchronous getversion request and returns parsed Cloud API version.

Method	Description
get()	Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
get_async()	Makes the asynchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
post()	Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
post_async()	Makes asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
get_api_version()	Makes synchronous getversion request and returns parsed Cloud API version.
get_api_version_async()	Makes asynchronous getversion request and returns parsed Cloud API version.