Personator Search

Personator Search#

Introduction #

Personator Search can:

An individual’s Current Address
An individual’s Previous Address
An individual’s Phone Numbers
An individual’s Email Addresses
Individuals living at an address
Individual/s tied to a phone number
Date of Birth and/or Date of Death
Name matches for a given area
Appended missing address line
Fuzzy Names/Nickname handling

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

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 Search will not function.

Initialization #

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

PersonatorSearch(string license)

Initialize the Cloud API object with a license key

C#
Python

PersonatorSearch personatorSearch = new PersonatorSearch(MELISSA_LICENSE_KEY);

personator_search = PersonatorSearch(MELISSA_LICENSE_KEY)

PersonatorSearch()

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

PersonatorSearch personatorSearch = new PersonatorSearch()

personator_search = PersonatorSearch()

Configuration #

Personator Search supports GET requests.

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

C#
Python

personatorSearch.SetValue("FullName", FULL_NAME);
personatorSearch.SetValue("AddressLine1", ADDRESS_LINE_1);
personatorSearch.SetValue("City", CITY);
personatorSearch.SetValue("State", STATE);
personatorSearch.SetValue("Postal", POSTAL_CODE);
personatorSearch.SetValue("Cols", COLS);

personator_search.set_value("full_name", FULL_NAME)
personator_search.set_value("address_line_1", ADDRESS_LINE_1)
personator_search.set_value("city", CITY)
personator_search.set_value("state", STATE)
personator_search.set_value("postal", POSTAL_CODE)
personator_search.set_value("cols", COLS)

Example

C#
Python

personatorSearch.SetValue("FullName", "Raymond Melissa");
personatorSearch.SetValue("AddressLine1", "22382 Avenida Empresa");
personatorSearch.SetValue("City", "Rancho Santa Margarita");
personatorSearch.SetValue("State", "CA");
personatorSearch.SetValue("Postal", "92688");
personatorSearch.SetValue("Cols", "GrpAll");

personator_search.set_value("full_name", "Raymond Melissa")
personator_search.set_value("address_line_1", "22382 Avenida Empresa")
personator_search.set_value("city", "Rancho Santa Margarita")
personator_search.set_value("state", "CA")
personator_search.set_value("postal", "92688")
personator_search.set_value("cols", "GrpAll")

Method 2: Using Direct Property Access #

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

Format

C#
Python

personatorSearch.FullName = FULL_NAME;
personatorSearch.AddressLine1 = ADDRESS_LINE_1;
personatorSearch.City = CITY;
personatorSearch.State = STATE;
personatorSearch.Postal = POSTAL_CODE;
personatorSearch.Cols = COLS;

personator_search.full_name = FULL_NAME
personator_search.address_line_1 = ADDRESS_LINE_1
personator_search.city = CITY
personator_search.state = STATE
personator_search.postal = POSTAL_CODE
personator_search.cols = COLS

Example

C#
Python

personatorSearch.FullName = "Raymond Melissa";
personatorSearch.AddressLine1 = "22382 Avenida Empresa";
personatorSearch.City = "Rancho Santa Margarita";
personatorSearch.State = "CA";
personatorSearch.Postal = "92688";
personatorSearch.Cols = "GrpAll";

personator_search.full_name = "Raymond Melissa"
personator_search.address_line_1 = "22382 Avenida Empresa"
personator_search.city = "Rancho Santa Margarita"
personator_search.state = "CA"
personator_search.postal = "92688"
personator_search.cols = "GrpAll"

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

C#
Python

personatorSearch.SetFullName(FULL_NAME);
personatorSearch.SetAddressLine1(ADDRESS_LINE_1);
personatorSearch.SetCity(CITY);
personatorSearch.SetState(STATE);
personatorSearch.SetPostal(POSTAL_CODE);
personatorSearch.SetCols(COLS);

personator_search.set_full_name(FULL_NAME)
personator_search.set_address_ine1(ADDRESS_LINE_1)
personator_search.set_city(CITY)
personator_search.set_state(STATE)
personator_search.set_postal(POSTAL_CODE)
personator_search.set_cols(COLS)

Example

C#
Python

personatorSearch.SetFullName("Raymond Melissa");
personatorSearch.SetAddressLine1("22382 Avenida Empresa");
personatorSearch.SetCity("Rancho Santa Margarita");
personatorSearch.SetState("CA");
personatorSearch.SetPostal("92688");
personatorSearch.SetCols("GrpAll");

personator_search.set_full_name("Raymond Melissa")
personator_search.set_address_ine1("22382 Avenida Empresa")
personator_search.set_city("Rancho Santa Margarita")
personator_search.set_state("CA")
personator_search.set_postal("92688")
personator_search.set_cols("GrpAll")

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)

As a Response Object #

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

C#
Python

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

response = personator.get(PersonatorSearchResponse)

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 Personator Search 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 Search 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
`PersonatorSearch()`	Constructor to initialize the Personator Search object.
`PersonatorSearch(string license)`	Constructor to initialize the Personator Search object with a license string.

Method	Description
`PersonatorSearch():`	Constructor to initialize the Personator Search object.
`PersonatorSearch(license):`	Constructor to initialize the Personator Search 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 SetTransmissionReference(string transmissionReference)`	Set the transmission reference.
`void SetOpt(string opt)`	Set the option.
`void SetCols(string cols)`	Set the columns.
`void SetFreeForm(string ff)`	Set the free form.
`void SetFullName(string fullName)`	Set the full name.
`void SetFirstName(string firstName)`	Set the first name.
`void SetLastName(string lastName)`	Set the last name.
`void SetAddressLine1(string addressLine1)`	Set the address line 1.
`void SetAction(string action)`	Set the action.
`void SetCity(string city)`	Set the city.
`void SetState(string state)`	Set the state.
`void SetPostal(string postal)`	Set the postal code.
`void SetPhone(string phone)`	Set the phone number.
`void SetEmail(string email)`	Set the email.
`void SetMAK(string mak)`	Set the MAK.
`void SetBirthDay(string birthDay)`	Set the birth day.
`void SetBirthMonth(string birthMonth)`	Set the birth month.
`void SetBirthYear(string birthYear)`	Set the birth year.
`void SetValue(string parameter, string value)`	Set the input parameter to a specified value.

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_transmission_reference(transmission_reference)`	Set the transmission reference.
`set_opt(opt)`	Set the option.
`set_cols(cols)`	Set the columns.
`set_free_form(ff)`	Set the free form.
`set_full_name(full_name)`	Set the full name.
`set_first_name(first_name)`	Set the first name.
`set_last_name(last_name)`	Set the last name.
`set_address_line_1(address_line_1)`	Set the address line 1.
`set_action(action)`	Set the action.
`set_city(city)`	Set the city.
`set_state(state)`	Set the state.
`set_postal(postal)`	Set the postal code.
`set_phone(phone)`	Set the phone number.
`set_email(email)`	Set the email.
`set_mak(mak)`	Set the MAK.
`set_birth_day(birth_day)`	Set the birth day.
`set_birth_month(birth_month)`	Set the birth month.
`set_birth_year(birth_year)`	Set the birth year.
`set_value(parameter, value)`	Set the input parameter to a specified value.

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 GetTransmissionReference()`	Get the transmission reference.
`string GetOpt()`	Get the option.
`string GetCols()`	Get the columns.
`string GetFreeForm()`	Get the free form.
`string GetFullName()`	Get the full name.
`string GetFirstName()`	Get the first name.
`string GetLastName()`	Get the last name.
`string GetAddressLine1()`	Get the address line 1.
`string GetAction()`	Get the action.
`string GetCity()`	Get the city.
`string GetState()`	Get the state.
`string GetPostal()`	Get the postal code.
`string GetPhone()`	Get the phone number.
`string GetEmail()`	Get the email.
`string GetMAK()`	Get the MAK.
`string GetBirthDay()`	Get the birth day.
`string GetBirthMonth()`	Get the birth month.
`string GetBirthYear()`	Get the birth year.
`void GetValue(string parameter)`	Get the value of an input parameter.

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_transmission_reference()`	Get the transmission reference.
`get_opt()`	Get the option.
`get_cols()`	Get the columns.
`get_free_form()`	Get the free form.
`get_full_name()`	Get the full name.
`get_first_name()`	Get the first name.
`get_last_name()`	Get the last name.
`get_address_line_1()`	Get the address line 1.
`get_action()`	Get the action.
`get_city()`	Get the city.
`get_state()`	Get the state.
`get_postal()`	Get the postal code.
`get_phone()`	Get the phone number.
`get_email()`	Get the email.
`get_mak()`	Get the MAK.
`get_birth_day()`	Get the birth day.
`get_birth_month()`	Get the birth month.
`get_birth_year()`	Get the birth year.
`get_value(parameter)`	Get the value of an input parameter.

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).
`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).
`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.

Personator Search

Contents

Personator Search#

Introduction #

Licensing #

Initialization #

Configuration #

Requests #

GET #

Method 1: Using Set Value Method #

Method 2: Using Direct Property Access #

Method 3: Using Specialized Methods #

Response #

As a String #

As a Response Object #

Accessing Values #

Methods #

Constructors #

Set Methods #

Get Methods #

Class Methods #