Personator Consumer

Personator Consumer#

Introduction#

Personator Consumer can:

  • Verify, Correct, & Standardize names, addresses, phones and emails

  • Retrieve move information

  • Append demographics

  • Append Geographic and Census data

Click here to learn more about the Personator Consumer 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 Consumer will not function.

Initialization#

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

PersonatorConsumer(string license)

Initialize the Cloud API object with a license key

  • C#
  • Python
PersonatorConsumer personator = new PersonatorConsumer(MELISSA_LICENSE_KEY);

personator = PersonatorConsumer(MELISSA_LICENSE_KEY)

PersonatorConsumer()

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
PersonatorConsumer personatorConsumer = new PersonatorConsumer()

personator_consumer = PersonatorConsumer()

Configuration#

Personator Consumer 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 PersonatorConsumerPostRequest object as the pre-constructed post body containing all parameters and records to process

  • (POST) Using Set Methods to configure base parameters and the Add Records Method to pass 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

  • C#
  • Python
personatorConsumer.SetValue("FullName", FULL_NAME);
personatorConsumer.SetValue("AddressLine1", ADDRESS_LINE_1);
personatorConsumer.SetValue("City", CITY);
personatorConsumer.SetValue("State", STATE);
personatorConsumer.SetValue("Postal", POSTAL_CODE);
personatorConsumer.SetValue("Country", COUNTRY);
personatorConsumer.SetValue("Email", EMAIL);
personatorConsumer.SetValue("Phone", PHONE);

personator_consumer.set_value("full_name", FULL_NAME)
personator_consumer.set_value("address_line1", ADDRESS_LINE_1)
personator_consumer.set_value("city", CITY)
personator_consumer.set_value("state", STATE)
personator_consumer.set_value("postal", POSTAL_CODE)
personator_consumer.set_value("country", COUNTRY)
personator_consumer.set_value("email", EMAIL)
personator_consumer.set_value("phone", PHONE)

Example

  • C#
  • Python
personatorConsumer.SetValue("FullName", "Raymond Melissa");
personatorConsumer.SetValue("AddressLine1", "22382 Avenida Empresa");
personatorConsumer.SetValue("City", "Rancho Santa Margarita");
personatorConsumer.SetValue("State", "CA");
personatorConsumer.SetValue("Postal", "92688");
personatorConsumer.SetValue("Country", "United States");
personatorConsumer.SetValue("Email", "info@melissa.com");
personatorConsumer.SetValue("Phone", "800-635-4772");

personator_consumer.set_value("full_name", "Raymond Melissa")
personator_consumer.set_value("address_line1", "22382 Avenida Empresa")
personator_consumer.set_value("city", "Rancho Santa Margarita")
personator_consumer.set_value("state", "CA")
personator_consumer.set_value("postal", "92688")
personator_consumer.set_value("country", "United States")
personator_consumer.set_value("email", "info@melissa.com")
personator_consumer.set_value("phone", "800-635-4772")
Method 2: Using Direct Property Access#

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

Format

  • C#
  • Python
personatorConsumer.FullName = FULL_NAME;
personatorConsumer.AddressLine1 = ADDRESS_LINE_1;
personatorConsumer.City = CITY;
personatorConsumer.State = STATE;
personatorConsumer.Postal = POSTAL_CODE;
personatorConsumer.Country = COUNTRY;
personatorConsumer.Email = EMAIL;
personatorConsumer.Phone = PHONE;

personator_consumer.full_name = FULL_NAME
personator_consumer.address_line1 = ADDRESS_LINE_1
personator_consumer.city = CITY
personator_consumer.state = STATE
personator_consumer.postal = POSTAL_CODE
personator_consumer.country = COUNTRY
personator_consumer.email = EMAIL
personator_consumer.phone = PHONE

Example

  • C#
  • Python
personatorConsumer.FullName = "Raymond Melissa";
personatorConsumer.AddressLine1 = "22382 Avenida Empresa";
personatorConsumer.City = "Rancho Santa Margarita";
personatorConsumer.State = "CA";
personatorConsumer.Postal = "92688";
personatorConsumer.Country = "United States";
personatorConsumer.Email = "info@melissa.com";
personatorConsumer.Phone = "800-635-4772";

personator_consumer.full_name = "Raymond Melissa"
personator_consumer.address_line1 = "22382 Avenida Empresa"
personator_consumer.city = "Rancho Santa Margarita"
personator_consumer.state = "CA"
personator_consumer.postal = "92688"
personator_consumer.country = "United States"
personator_consumer.email = "info@melissa.com"
personator_consumer.phone = "800-635-4772"
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
personatorConsumer.SetFullName(FULL_NAME);
personatorConsumer.SetAddressLine1(ADDRESS_LINE_1);
personatorConsumer.SetCity(CITY);
personatorConsumer.SetState(STATE);
personatorConsumer.SetPostal(POSTAL_CODE);
personatorConsumer.SetCountry(COUNTRY);
personatorConsumer.SetEmail(EMAIL);
personatorConsumer.SetPhone(PHONE);

personator_consumer.set_full_name(FULL_NAME)
personator_consumer.set_address_line1(ADDRESS_LINE_1)
personator_consumer.set_city(CITY)
personator_consumer.set_state(STATE)
personator_consumer.set_postal(POSTAL_CODE)
personator_consumer.set_country(COUNTRY)
personator_consumer.set_email(EMAIL)
personator_consumer.set_phone(PHONE)

Example

  • C#
  • Python
personatorConsumer.SetFullName("Raymond Melissa");
personatorConsumer.SetAddressLine1("22382 Avenida Empresa");
personatorConsumer.SetCity("Rancho Santa Margarita");
personatorConsumer.SetState("CA");
personatorConsumer.SetPostal("92688");
personatorConsumer.SetCountry("United States");
personatorConsumer.SetEmail("info@melissa.com");
personatorConsumer.SetPhone("800-635-4772");

personator_consumer.set_full_name("Raymond Melissa")
personator_consumer.set_address_line1("22382 Avenida Empresa")
personator_consumer.set_city("Rancho Santa Margarita")
personator_consumer.set_state("CA")
personator_consumer.set_postal("92688")
personator_consumer.set_country("United States")
personator_consumer.set_email("info@melissa.com")
personator_consumer.set_phone("800-635-4772")

POST#

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

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

  • Method 2: Using Set Methods to configure base parameters and the Add Records Method to pass records to process

A maximum of 100 records can be sent per request.

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

  • C#
  • Python
personatorConsumer.SetPostBody(new PersonatorConsumerPostRequest
{
    CustomerID = MELISSA_LICENSE_KEY,
    Records = new List<PersonatorConsumerRecordRequest>
    {
      new PersonatorConsumerRecordRequest
      {
        RecordID = RECORD_ID
        FullName = FULL_NAME,
        AddressLine1 = ADDRESS_LINE_1,
        City = CITY,
        State = STATE,
        PostalCode = POSTAL_CODE
      },
      new PersonatorConsumerRecordRequest
      {
        RecordID = RECORD_ID
        FullName = FULL_NAME,
        AddressLine1 = ADDRESS_LINE_1,
        City = CITY,
        State = STATE,
        PostalCode = POSTAL_CODE
      }
    }
});

personator_consumer.set_post_body(PersonatorConsumerPostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  records=[
    PersonatorConsumerRecordRequest(
      record_id = RECORD_ID,
      full_name = FULL_NAME,
      address_line1 = ADDRESS_LINE_1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE
    ),
    PersonatorConsumerRecordRequest(
      record_id = RECORD_ID,
      full_name = FULL_NAME,
      address_line1 = ADDRESS_LINE_1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE
    )
  ]
))

Example

  • C#
  • Python
personatorConsumer.SetPostBody(new PersonatorConsumerPostRequest
{
    CustomerID = MELISSA_LICENSE_KEY,
    Records = new List<PersonatorConsumerRecordRequest>
    {
      new PersonatorConsumerRecordRequest
      {
        RecordID = "1"
        FullName = "Raymond Melissa",
        AddressLine1 = "22382 Avenida Empresa",
        City = "Rancho Santa Margarita",
        State = "CA",
        PostalCode = "92688"
      },
      new PersonatorConsumerRecordRequest
      {
        RecordID = "2"
        FullName = "John Melissa",
        AddressLine1 = "22382 Avenida Empresa",
        City = "Rancho Santa Margarita",
        State = "CA",
        PostalCode = "92688"
      }
    }
});

personator_consumer.set_post_body(PersonatorConsumerPostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  records=[
      PersonatorConsumerRecordRequest(
          record_id = "1",
          full_name = "Raymond Melissa",
          address_line1 = "22382 Avenida Empresa",
          city =  "Rancho Santa Margarita",
          state = "CA",
          postal_code = "92688"
      ),
      PersonatorConsumerRecordRequest(
          record_id = "2",
          full_name = "John Melissa",
          address_line1 = "22382 Avenida Empresa",
          city = "Rancho Santa Margarita",
          state = "CA",
          postal_code = "92688"
      )
  ]
))
Method 2: Set Input Parameters and Add Records#

You will use set methods to configure the base parameters (license, options, transmission reference), and use the function below to add records for POST requests.

See Set Methods for a list of available parameters.

Format

  • C#
  • Python
personatorConsumer.SetLicense(MELISSA_LICENSE_KEY);

personatorConsumer.AddRecord(new PersonatorConsumerRecordRequest
{
  RecordID = RECORD_ID,
  FullName = FULL_NAME,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE
});

personatorConsumer.AddRecord(new PersonatorConsumerRecordRequest
{
  RecordID = RECORD_ID,
  FullName = FULL_NAME,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE
});

personator_consumer = PersonatorConsumer(MELISSA_LICENSE_KEY)

personator_consumer.add_record(PersonatorConsumerRecordRequest(
  record_id = RECORD_ID,
  full_name = FULL_NAME,
  address_line1 = ADDRESS_LINE_1,
  city = CITY,
  state = STATE,
  postal_code = POSTAL_CODE
))

personator_consumer.add_record(PersonatorConsumerRecordRequest(
  record_id = RECORD_ID,
  full_name = FULL_NAME,
  address_line1 = ADDRESS_LINE_1,
  city = CITY,
  state = STATE,
  postal_code = POSTAL_CODE
))

Example

  • C#
  • Python
personatorConsumer.SetLicense(MELISSA_LICENSE_KEY);

personatorConsumer.AddRecord(new PersonatorConsumerRecordRequest
{
  RecordID = "1",
  FullName = "Raymond Melissa",
  AddressLine1 = "22382 Avenida Empresa",
  City = "Rancho Santa Margarita",
  State = "CA",
  PostalCode = "92688"
});

personatorConsumer.AddRecord(new PersonatorConsumerRecordRequest
{
  RecordID = "1",
  FullName = "John Melissa",
  AddressLine1 = "22382 Avenida Empresa",
  City = "Rancho Santa Margarita",
  State = "CA",
  PostalCode = "92688"
});

personator_consumer = PersonatorConsumer(MELISSA_LICENSE_KEY)

personator_consumer.add_record(PersonatorConsumerRecordRequest(
  record_id = "1",
  full_name = "Raymond Melissa",
  address_line1 = "22382 Avenida Empresa",
  city = "Rancho Santa Margarita",
  state = "CA",
  postal_code = "92688"
))

personator_consumer.add_record(PersonatorConsumerRecordRequest(
  record_id = "2",
  full_name = "John Melissa",
  address_line1 = "22382 Avenida Empresa",
  city = "Rancho Santa Margarita",
  state = "CA",
  postal_code = "92688"
))

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 = personatorConsumer.Get<string>();

response = personator_consumer.get(str)
  • C#
  • Python
string response = personatorConsumer.Post<string>();

response = personator_consumer.post(str)

As a Response Object#

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

  • C#
  • Python
PersonatorConsumerResponse responseObject = globalAddress.Get<PersonatorConsumerResponse>();

response = personator_consumer.get(PersonatorConsumerResponse)
  • C#
  • Python
PersonatorConsumerResponse responseObject = globalAddress.Post<PersonatorConsumerResponse>();

response = personator_consumer.post(PersonatorConsumerResponse)
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 Consumer 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 Consumer 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

PersonatorConsumer()

Constructor to initialize the Personator Consumer object.

PersonatorConsumer(string license)

Constructor to initialize the Personator Consumer object with a license string.

Method

Description

PersonatorConsumer()

Constructor to initialize the Personator Consumer object.

PersonatorConsumer(license)

Constructor to initialize the Personator Consumer 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 SetAddressLine1(string addressLine1)

Set the address line 1.

void SetAddressLine2(string addressLine2)

Set the address line 2.

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 SetCity(string city)

Set the city.

void SetCompany(string company)

Set the company.

void SetCountry(string country)

Set the country.

void SetEmail(string email)

Set the email.

void SetFirstName(string firstName)

Set the first name.

void SetFreeForm(string ff)

Set the free form.

void SetFullName(string fullName)

Set the full name.

void SetIP(string ip)

Set the IP address.

void SetLastLine(string lastLine)

Set the last line.

void SetLastName(string lastName)

Set the last name.

void SetMAK(string mak)

Set the MAK.

void SetMIK(string mik)

Set the MIK.

void SetPhone(string phone)

Set the phone number.

void SetPostal(string postal)

Set the postal code.

void SetSSN(string ssn)

Set the SSN.

void SetState(string state)

Set the state.

void SetTransmissionReference(string transmissionReference)

Set the transmission reference.

void SetOpt(string opt)

Set the option.

void SetCols(string cols)

Set the columns.

void SetValue(string parameter, string value)

Set the input parameter to a specified value.

void SetPostBody(PersonatorConsumerBatchRequest postBody)

Set 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_address_line1(address_line1)

Set the address line 1.

set_address_line2(address_line2)

Set the address line 2.

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_city(city)

Set the city.

set_company(company)

Set the company.

set_country(country)

Set the country.

set_email(email)

Set the email.

set_first_name(first_name)

Set the first name.

set_free_form(ff)

Set the free form.

set_full_name(full_name)

Set the full name.

set_ip(ip)

Set the IP address.

set_last_line(last_line)

Set the last line.

set_last_name(last_name)

Set the last name.

set_mak(mak)

Set the MAK.

set_mik(mik)

Set the MIK.

set_phone(phone)

Set the phone number.

set_postal(postal)

Set the postal code.

set_ssn(ssn)

Set the SSN.

set_state(state)

Set the state.

set_transmission_reference(transmission_reference)

Set the transmission reference.

set_opt(opt)

Set the option.

set_cols(cols)

Set the columns.

set_value(parameter, value)

Set the input parameter to a specified value.

set_post_body(post_body)

Set 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 GetAddressLine1()

Get the address line 1.

string GetAddressLine2()

Get the address line 2.

string GetBirthDay()

Get the birth day.

string GetBirthMonth()

Get the birth month.

string GetBirthYear()

Get the birth year.

string GetCity()

Get the city.

string GetCompany()

Get the company.

string GetCountry()

Get the country.

string GetEmail()

Get the email.

string GetFirstName()

Get the first name.

string GetFreeForm()

Get the free form.

string GetFullName()

Get the full name.

string GetIP()

Get the IP address.

string GetLastLine()

Get the last line.

string GetLastName()

Get the last name.

string GetMAK()

Get the MAK.

string GetMIK()

Get the MIK.

string GetPhone()

Get the phone number.

string GetPostal()

Get the postal code.

string GetSSN()

Get the SSN.

string GetState()

Get the state.

string GetTransmissionReference()

Get the transmission reference.

string GetOpt()

Get the option.

string GetCols()

Get the columns.

string GetValue(string parameter)

Get the value of an input parameter.

PersonatorConsumerBatchRequest GetPostBody()

Get 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_address_line1()

Get the address line 1.

get_address_line2()

Get the address line 2.

get_birth_day()

Get the birth day.

get_birth_month()

Get the birth month.

get_birth_year()

Get the birth year.

get_city()

Get the city.

get_company()

Get the company.

get_country()

Get the country.

get_email()

Get the email.

get_first_name()

Get the first name.

get_free_form()

Get the free form.

get_full_name()

Get the full name.

get_ip()

Get the IP address.

get_last_line()

Get the last line.

get_last_name()

Get the last name.

get_mak()

Get the MAK.

get_mik()

Get the MIK.

get_phone()

Get the phone number.

get_postal()

Get the postal code.

get_ssn()

Get the SSN.

get_state()

Get the state.

get_transmission_reference()

Get the transmission reference.

get_opt()

Get the option.

get_cols()

Get the columns.

get_value(parameter)

Get the value of an input parameter.

get_post_body()

Get post body for post requests.

Get 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

void AddRecord(GlobalIPRecordRequest record)

Add record to internal list for post body assembly.

void ClearRecords()

Clear the internal list of records.

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

add_record(record)

Add record to internal list for post body assembly.

clear_records()

Clear the internal list of records.

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