People Business Search

People Business Search#

Introduction #

People Business Search can:

Search for individuals and businesses across the US.
Perform searches with partial/limited information on the address, name or company to correct records that would otherwise be unresolvable.
Locate individuals for billing purposes, such as tracking down people who have skipped out on their bills.
Validate policyholder addresses before issuing policies, to reduce the risk of fraud and errors.
Find potential customers by targeting your marketing campaigns to specific locations.
Retrieve contact phone information for an individual or business.

Click here to learn more about the People Business 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, People Business Search will not function.

Initialization #

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

PeopleBusinessSearch(string license)

Initialize the Cloud API object with a license key

C#
Python

PeopleBusinessSearch peopleBusiness = new PeopleBusinessSearch(MELISSA_LICENSE_KEY);

people_business = PeopleBusinessSearch(MELISSA_LICENSE_KEY)

PeopleBusinessSearch()

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

PeopleBusinessSearch peopleBusiness = new PeopleBusinessSearch()

people_business = PeopleBusinessSearch()

Configuration #

People Business Search 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 PeopleBusinessSearchPostRequest 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

C#
Python

peopleBusiness.SetValue("MaxRecords", MAX_RECORDS);
peopleBusiness.SetValue("MatchLevel", MATCH_LEVEL);
peopleBusiness.SetValue("AddressLine1", ADDRESS_LINE_1);
peopleBusiness.SetValue("Locality", LOCALITY);
peopleBusiness.SetValue("AdministrativeArea", ADMINISTRATIVE_AREA);
peopleBusiness.SetValue("Postal", POSTAL_CODE);
peopleBusiness.SetValue("AnyName", ANY_NAME);

people_business.set_value("max_records", MAX_RECORDS)
people_business.set_value("match_level", MATCH_LEVEL)
people_business.set_value("address_line_1", ADDRESS_LINE_1)
people_business.set_value("locality", LOCALITY)
people_business.set_value("administrative_area", ADMINISTRATIVE_AREA)
people_business.set_value("postal", POSTAL_CODE)
people_business.set_value("any_name", ANY_NAME)

Example

C#
Python

peopleBusiness.SetValue("MaxRecords", "10");
peopleBusiness.SetValue("MatchLevel", "10");
peopleBusiness.SetValue("AddressLine1", "22382 Avenida Empresa");
peopleBusiness.SetValue("Locality", "RSM");
peopleBusiness.SetValue("AdministrativeArea", "CA");
peopleBusiness.SetValue("Postal", "92688");
peopleBusiness.SetValue("AnyName", "Melissa Data");

people_business.set_value("max_records", "10")
people_business.set_value("match_level", "10")
people_business.set_value("address_line_1", "22382 Avenida Empresa")
people_business.set_value("locality", "RSM")
people_business.set_value("administrative_area", "CA")
people_business.set_value("postal", "92688")
people_business.set_value("any_name", "Melissa Data")

Method 2: Using Direct Property Access #

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

Format

C#
Python

peopleBusiness.MaxRecords = MAX_RECORDS;
peopleBusiness.MatchLevel = MATCH_LEVEL;
peopleBusiness.AddressLine1 = ADDRESS_LINE_1;
peopleBusiness.Locality = LOCALITY;
peopleBusiness.AdministrativeArea = ADMINISTRATIVE_AREA;
peopleBusiness.Postal = POSTAL_CODE;
peopleBusiness.AnyName = ANY_NAME;

people_business.max_records = MAX_RECORDS
people_business.match_level = MATCH_LEVEL
people_business.address_line_1 = ADDRESS_LINE_1
people_business.locality = LOCALITY
people_business.administrative_area = ADMINISTRATIVE_AREA
people_business.postal = POSTAL_CODE
people_business.any_name = ANY_NAME

Example

C#
Python

peopleBusiness.MaxRecords = "10";
peopleBusiness.MatchLevel = "10";
peopleBusiness.AddressLine1 = "22382 Avenida Empresa";
peopleBusiness.Locality = "RSM";
peopleBusiness.AdministrativeArea = "CA";
peopleBusiness.Postal = "92688";
peopleBusiness.AnyName = "Melissa Data";

people_business.max_records = "10"
people_business.match_level = "10"
people_business.address_line_1 = "22382 Avenida Empresa"
people_business.locality = "RSM"
people_business.administrative_area = "CA"
people_business.postal = "92688"
people_business.any_name = "Melissa Data"

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

peopleBusiness.SetMaxRecords(MAX_RECORDS);
peopleBusiness.SetMatchLevel(MATCH_LEVEL);
peopleBusiness.SetAddressLine1(ADDRESS_LINE_1);
peopleBusiness.SetLocality(LOCALITY);
peopleBusiness.SetAdministrativeArea(ADMINISTRATIVE_AREA);
peopleBusiness.SetPostal(POSTAL_CODE);
peopleBusiness.SetAnyName(ANY_NAME);

people_business.set_max_records(MAX_RECORDS)
people_business.set_match_level(MATCH_LEVEL)
people_business.set_address_line_1(ADDRESS_LINE_1)
people_business.set_locality(LOCALITY)
people_business.set_administrative_area(ADMINISTRATIVE_AREA)
people_business.set_postal(POSTAL_CODE)
people_business.set_any_name(ANY_NAME)

Example

C#
Python

peopleBusiness.SetMaxRecords("10");
peopleBusiness.SetMatchLevel("10");
peopleBusiness.SetAddressLine1("22382 Avenida Empresa");
peopleBusiness.SetLocality("RSM");
peopleBusiness.SetAdministrativeArea("CA");
peopleBusiness.SetPostal("92688");
peopleBusiness.SetAnyName("Melissa Data");

people_business.set_max_records("10")
people_business.set_match_level("10")
people_business.set_address_line_1("22382 Avenida Empresa")
people_business.set_locality("RSM")
people_business.set_administrative_area("CA")
people_business.set_postal("92688")
people_business.set_any_name("Melissa Data")

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 PeopleBusinessSearchPostRequest 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

C#
Python

peopleBusiness.SetPostBody(new PeopleBusinessSearchRecordRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  MaxRecords = MAX_RECORDS,
  MatchLevel = MATCH_LEVEL,
  AddressLine1 = ADDRESS_LINE_1,
  Locality = LOCALITY,
  AdministrativeArea = ADMINISTRATIVE_AREA,
  PostalCode = POSTAL_CODE,
  AnyName = ANY_NAME
});

people_business.set_post_body(PeopleBusinessSearchPostRequest(
  records=[
    PeopleBusinessSearchRecordRequest(
      customer_id = MELISSA_LICENSE_KEY,
      max_records = MAX_RECORDS,
      match_level = MATCH_LEVEL,
      address_line_1 = ADDRESS_LINE_1,
      locality = LOCALITY,
      administrative_area = ADMINISTRATIVE_AREA,
      postal_code = POSTAL_CODE,
      any_name = ANY_NAME
    )
  ]
))

Example

C#
Python

peopleBusiness.SetPostBody(new PeopleBusinessSearchRecordRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  MaxRecords = "10",
  MatchLevel = "10",
  AddressLine1 = "22382 Avenida Empresa",
  Locality = "RSM",
  AdministrativeArea = "CA",
  PostalCode = "92688",
  AnyName = "Melissa Data"
});

people_business.set_post_body(PeopleBusinessSearchPostRequest(
  records=[
    PeopleBusinessSearchRecordRequest(
      customer_id = MELISSA_LICENSE_KEY,
      max_records = "10",
      match_level = "10",
      address_line_1 = "22382 Avenida Empresa",
      locality = "RSM",
      administrative_area = "CA",
      postal_code = "92688",
      any_name = "Melissa Data"
    )
  ]
))

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

response = people_business.get(str)

C#
Python

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

response = people_business.post(str)

As a Response Object #

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

C#
Python

PeopleBusinessSearchResponse responseObject = peopleBusiness.Get<PeopleBusinessSearchResponse>();

response_object = people_business.get(PeopleBusinessSearchResponse)

C#
Python

PeopleBusinessSearchResponse responseObject = peopleBusiness.Post<PeopleBusinessSearchResponse>();

response_object = people_business.post(PeopleBusinessSearchResponse)

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

Method	Description
`PeopleBusinessSearch()`	Constructor to initialize the People Business Search object.
`PeopleBusinessSearch(license)`	Constructor to initialize the People Business 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 SetAddressLine1(string addressLine1)`	Set the address line 1.
`void SetAdministrativeArea(string administrativeArea)`	Set the administrative area.
`void SetCountry(string country)`	Set the country.
`void SetLocality(string locality)`	Set the locality.
`void SetPhone(string phone)`	Set the phone number.
`void SetPostal(string postal)`	Set the postal code.
`void SetPostDirection(string postDirection)`	Set the post-direction.
`void SetPreDirection(string preDirection)`	Set the pre-direction.
`void SetPremisesNumber(string premisesNumber)`	Set the premises number.
`void SetSubPremisesNumber(string subPremisesNumber)`	Set the subpremises number.
`void SetThoroughfareName(string thoroughfareName)`	Set the thoroughfare name.
`void SetTrailingType(string trailingType)`	Set the thoroughfare trailing type.
`void SetAnyName(string anyName)`	Set the name.
`void SetCompany(string company)`	Set the company.
`void SetFirstName(string firstName)`	Set the first name.
`void SetFullName(string fullName)`	Set the full name.
`void SetLastName(string lastName)`	Set the last name.
`void SetSubUser(string subUser)`	Set the subuser.
`void SetTransmissionReference(string transmissionReference)`	Set the transmission reference.
`void SetMatchLevel(string matchLevel)`	Set the match level.
`void SetMaxRecords(string maxRecords)`	Set the max records.
`void SetValue(string parameter, string value)`	Set the input parameter to a specified value.
`void SetPostBody(PeopleBusinessSearchRecordRequest 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_address_line1(address_line1)`	Set the address line 1.
`set_administrative_area(administrative_area)`	Set the administrative area.
`set_country(country)`	Set the country.
`set_locality(locality)`	Set the locality.
`set_phone(phone)`	Set the phone number.
`set_postal(postal)`	Set the postal code.
`set_post_direction(post_direction)`	Set the post-direction.
`set_pre_direction(pre_direction)`	Set the pre-direction.
`set_premises_number(premises_number)`	Set the premises number.
`set_sub_premises_number(sub_premises_number)`	Set the subpremises number.
`set_thoroughfare_name(thoroughfare_name)`	Set the thoroughfare name.
`set_trailing_type(trailing_type)`	Set the thoroughfare trailing type.
`set_any_name(any_name)`	Set the name.
`set_company(company)`	Set the company.
`set_first_name(first_name)`	Set the first name.
`set_full_name(full_name)`	Set the full name.
`set_last_name(last_name)`	Set the last name.
`set_sub_user(sub_user)`	Set the subuser.
`set_transmission_reference(transmission_reference)`	Set the transmission reference.
`set_match_level(match_level)`	Set the match level.
`set_max_records(max_records)`	Set the max records.
`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 GetAddressLine1()`	Get the address line 1.
`string GetAdministrativeArea()`	Get the administrative area.
`string GetCountry()`	Get the country.
`string GetLocality()`	Get the locality.
`string GetPhone()`	Get the phone number.
`string GetPostal()`	Get the postal code.
`string GetPostDirection()`	Get the post-direction.
`string GetPreDirection()`	Get the pre-direction.
`string GetPremisesNumber()`	Get the premises number.
`string GetSubPremisesNumber()`	Get the subpremises number.
`string GetThoroughfareName()`	Get the thoroughfare name.
`string GetTrailingType()`	Get the thoroughfare trailing type.
`string GetAnyName()`	Get the name.
`string GetCompany()`	Get the company.
`string GetFirstName()`	Get the first name.
`string GetFullName()`	Get the full name.
`string GetLastName()`	Get the last name.
`string GetSubUser()`	Get the subuser.
`string GetTransmissionReference()`	Get the transmission reference.
`string GetMatchLevel()`	Get the match level.
`string GetMaxRecords()`	Get the max records.
`void GetValue(string parameter)`	Get the value of an input parameter.
`PeopleBusinessSearchRecordRequest 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_address_line1()`	Get the address line 1.
`get_administrative_area()`	Get the administrative area.
`get_country()`	Get the country.
`get_locality()`	Get the locality.
`get_phone()`	Get the phone number.
`get_postal()`	Get the postal code.
`get_post_direction()`	Get the post-direction.
`get_pre_direction()`	Get the pre-direction.
`get_premises_number()`	Get the premises number.
`get_sub_premises_number()`	Get the subpremises number.
`get_thoroughfare_name()`	Get the thoroughfare name.
`get_trailing_type()`	Get the thoroughfare trailing type.
`get_any_name()`	Get the name.
`get_company()`	Get the company.
`get_first_name()`	Get the first name.
`get_full_name()`	Get the full name.
`get_last_name()`	Get the last name.
`get_sub_user()`	Get the subuser.
`get_transmission_reference()`	Get the transmission reference.
`get_match_level()`	Get the match level.
`get_max_records()`	Get the max records.
`get_value(parameter)`	Get the value of an input parameter.
`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
`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 a 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 an asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`string GetApiVersion()`	Makes a synchronous getversion request and returns the parsed Cloud API version.
`async Task<string> GetApiVersionAsync()`	Makes an asynchronous getversion request and returns the 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(response_type)`	Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`get_async(response_type)`	Makes the asynchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`post(response_type)`	Makes a synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_async(response_type)`	Makes an asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_api_version()`	Makes a synchronous getversion request and returns the parsed Cloud API version.
`get_api_version_async()`	Makes an asynchronous getversion request and returns the parsed Cloud API version.

People Business Search

Contents

People Business Search#

Introduction #

Licensing #

Initialization #

Configuration #

Requests #

GET #

Method 1: Using Set Value Method #

Method 2: Using Direct Property Access #

Method 3: Using Specialized Methods #

POST #

Method 1: Set Post Body #

Response #

As a String #

As a Response Object #

Accessing Values #

Methods #

Constructors #

Set Methods #

Get Methods #

Class Methods #