Melissa

https://docs.melissa.com/
Admin
Melissa is a comprehensive data quality and location intelligence platform providing APIs, software,...
Tokens:1,075,694
Snippets:9,366
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example GET Request Parameters

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/personator-identity-package.html

Configures request parameters with concrete example values.

```C#
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");
```

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

--------------------------------

### Execute Unison installation script

Source: https://docs.melissa.com/software/unison/unison-quickstart.html

Run the installation script with root privileges to begin the setup process.

```bash
sudo ./install.sh
```

--------------------------------

### Example GET Request Configuration using Direct Property Access (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/reverse-geocoder-package.html

Example demonstrating how to set latitude, longitude, and max_records using direct property access.

```python
reverse_geo_coder.latitude = "33.637520"
reverse_geo_coder.longitude = "-117.606920"
reverse_geo_coder.max_records = "3"
```

--------------------------------

### Example GET Request Configuration using Direct Property Access (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/reverse-geocoder-package.html

Example demonstrating how to set Latitude, Longitude, and MaxRecords using direct property access.

```csharp
reverseGeoCoder.Latitude = "33.637520";
reverseGeoCoder.Longitude = "-117.606920";
reverseGeoCoder.MaxRecords = "3";
```

--------------------------------

### Example GET Request Configuration using set_value (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/reverse-geocoder-package.html

Example demonstrating how to set latitude, longitude, and max_records using the set_value method.

```python
reverse_geo_coder.set_value("latitude", "33.637520")
reverse_geo_coder.set_value("longitude", "-117.606920")
reverse_geo_coder.set_value("max_records", "3")
```

--------------------------------

### GET JSON Example

Source: https://docs.melissa.com/cloud-api/personator-search/personator-search-reference-guide.html

Example of a GET request in JSON format, including headers and response.

```APIDOC
## GET /api/personator/search

### Description
Performs a search using the Personator API to retrieve records based on specified criteria.

### Method
GET

### Endpoint
`/api/personator/search`

### Headers
```
Content-Type: application/json
Accept: application/json
```

### Response
#### Success Response (200)
- **TransmissionResults** (string) - Result codes from the service.
- **TransmissionReference** (string) - Pass-through of the input TransmissionReference field.
- **TotalPages** (string) - The number of total pages returned by the request.
- **TotalRecords** (string) - The number of total records returned by the request, up to a maximum of 500.
- **Version** (string) - The current service version number.
- **Records** (array) - An array of returned records.
  - **RecordID** (string) - The ID of the record.
  - **Results** (string) - Result codes for the specific record.
  - **FullName** (string) - The full name of the individual.
  - **FirstName** (string) - The first name of the individual.
  - **MiddleName** (string) - The middle name of the individual.
  - **LastName** (string) - The last name of the individual.
  - **Suffix** (string) - The suffix of the name.
  - **DateOfBirth** (string) - The date of birth.
  - **DateOfDeath** (string) - The date of death.
  - **MelissaIdentityKey** (string) - The Melissa Identity Key.
  - **CurrentAddress** (object) - The current address details.
    - **AddressLine1** (string) - The first line of the address.
    - **Suite** (string) - The suite or apartment number.
    - **City** (string) - The city.
    - **State** (string) - The state.
    - **PostalCode** (string) - The postal code.
    - **Plus4** (string) - The plus-four extension of the postal code.
    - **MelissaAddressKey** (string) - The Melissa Address Key.
    - **MelissaAddressKeyBase** (string) - The Melissa Address Key Base.
    - **MoveDate** (string) - The date of the move.
  - **PreviousAddresses** (array) - An array of previous addresses.
  - **PhoneRecords** (array) - An array of phone records.
    - **phoneNumber** (string) - The phone number.
  - **EmailRecords** (array) - An array of email records.
    - **email** (string) - The email address.

#### Response Example
```json
{
   "TransmissionResults": "US01",
   "TransmissionReference": "Test",
   "TotalPages": "1",
   "TotalRecords": "1",
   "Version": "9.2.5.1145",
   "Records":
   [
      {
         "RecordID": "1",
         "Results": "VR01",
         "FullName": "Melissa MelissaData Data",
         "FirstName": "Melissa",
         "MiddleName": "MelissaData",
         "LastName": "Data",
         "Suffix":"",
         "DateOfBirth": "",
         "DateOfDeath": "",
         "MelissaIdentityKey": "",
         "CurrentAddress":
         {
            "AddressLine1": "22382 Avenida Empresa",
            "Suite": "",
            "City": "Rancho Santa Margarita",
            "State": "CA",
            "PostalCode": "92688",
            "Plus4": "2112",
            "MelissaAddressKey": "8008006245",
            "MelissaAddressKeyBase": "",
            "MoveDate":""
         },
         "PreviousAddresses": [],
         "PhoneRecords":
         [
            {
               "phoneNumber": "9498583000"
            }
         ],
         "EmailRecords":
         [
            {
               "email": "tech@melissa.com"
            }
         ]
      }
   ]
}
```
```

--------------------------------

### Setup and Initialization Methods

Source: https://docs.melissa.com/on-premise-api/global-address-object/global-address-object-reference-guide.html

Functions for initializing the Global Address Object, setting license keys, and configuring data file paths.

```APIDOC
## POST /api/initializeDataFiles

### Description
Initializes the reference data files for the Global Address Object.

### Method
POST

### Endpoint
/api/initializeDataFiles

### Parameters
This function takes no parameters.

### Request Example
```json
{
  "action": "InitializeDataFiles"
}
```

### Response
#### Success Response (200)
- **Initialization Status** (ProgramStatus) - Indicates the status of the data file initialization.
```

```APIDOC
## POST /api/setLicenseString

### Description
Sets the License Key for the Global Address Object. This can also be set via an environmental variable.

### Method
POST

### Endpoint
/api/setLicenseString

### Parameters
#### Request Body
- **License** (String) - Required - The license key string.

### Request Example
```json
{
  "action": "SetLicenseString",
  "License": "YOUR_LICENSE_KEY"
}
```

### Response
#### Success Response (200)
- **Successful** (Boolean) - Returns true if the license string was set successfully.
```

```APIDOC
## POST /api/setPathToGlobalAddrFiles

### Description
Sets the physical path to the Global Address Object's reference data files.

### Method
POST

### Endpoint
/api/setPathToGlobalAddrFiles

### Parameters
#### Request Body
- **FilePath** (String) - Required - The full path to the reference data files.

### Request Example
```json
{
  "action": "SetPathToGlobalAddrFiles",
  "FilePath": "/path/to/global/address/files"
}
```

### Response
#### Success Response (200)
This endpoint does not return a specific value upon success (Void return type).
```

--------------------------------

### GET JSON Response Example

Source: https://docs.melissa.com/cloud-api/global-ip/global-ip-reference-guide.html

Example response structure for a GET request to the IP Locator service.

```json
{
    "Version": "6.2.0.1122",
    "TransmissionReference": "IP Locator Test",
    "TransmissionResults": "",
    "Records": [
        {
            "City": "Rancho Santa Margarita",
            "ConnectionSpeed": "broadband",
            "ConnectionType": "wifi",
            "Continent": "North America",
            "CountryAbbreviation": "US",
            "CountryName": "United States",
            "DomainAddress1":"DomainsByProxy.com2155 E Warner Rd",
            "DomainAdministrativeArea": "Arizona",
            "DomainAgeEstimated": "8172",
            "DomainAvailability": "UNAVAILABLE",
            "DomainCountry": "UNITED STATES",
            "DomainCountryCode": "US",
            "DomainCreatedDate": "2000-10-16T20:48:37",
            "DomainEmail": " ",
            "DomainExpirationDate": "2023-10-16T20:48:36",
            "DomainLocality": "Tempe",
            "DomainName": "melissadata.com",
            "DomainOrganization": "Domains By Proxy, LLC",
            "DomainPostalCode": "85284",
            "DomainPrivateProxy": "1",
            "DomainUpdatedDate": "2022-10-17T07:46:22",
            "DST": "Y",
            "IPAddress": "12.203.219.6",
            "ISPName": "Att Services Inc.",
            "Latitude": "33.650000",
            "Longitude": "-117.590000",
            "PostalCode": "92688",
            "ProxyDescription": "att",
            "ProxyType": " ",
            "RecordID": "1",
            "Region": "California",
            "Result": "IS01",
            "TimeZoneCode": "PST",
            "TimeZoneName": "Pacific Standard Time",
            "UTC": "-08:00"
        }
    ]
}
```

--------------------------------

### Set License and Add Records with Example Values (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/global-ip-package.html

Example of setting the license and adding records with specific IDs and IP addresses. Replace MELISSA_LICENSE_KEY with your license.

```python
global_ip = GlobalIP(MELISSA_LICENSE_KEY)

global_ip.add_record(GlobalIPRecordRequest(
    record_id = "1",
    ip_address = "12.203.219.6"
))

global_ip.add_record(GlobalIPRecordRequest(
    record_id = "2",
    ip_address = "139.101.81.42"
))
```

--------------------------------

### GET XML Response Example

Source: https://docs.melissa.com/cloud-api/property/property-reference-guide.html

This is an example of an XML response for a GET request, representing property deed information.

```xml
<LookupDeedsResponse
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://schemas.datacontract.org/2004/07/PropertyWS">
  <Version>9.4.2.1107</Version>
  <TransmissionReference>Test</TransmissionReference>
  <Results>YS07</Results>
  <TotalRecords>1</TotalRecords>
  <Records>
    <Record>
      <DocInfo>
        <RecordingDate>20221222</RecordingDate>
      </DocInfo>
      <TxDefInfo>
        <TransactionType>21</TransactionType>
      </TxDefInfo>
      <TxAmtInfo>
        <TransferAmount>0.00</TransferAmount>
      </TxAmtInfo>
      <PropertyAddress />
      <PrimaryGrantor>
        <Name1Full>Mohammad A Jamal</Name1Full>
        <Name2Full>Farida M Jamal</Name2Full>
      </PrimaryGrantor>
      <SecondaryGrantor />
      <PrimaryGrantee>
        <Name1Full>Rogelio Ramirez</Name1Full>
        <Name2Full>Kimberly Ramirez</Name2Full>
      </PrimaryGrantee>
      <SecondaryGrantee />
      <TitleCompInfo>
        <StandardizedName>Texas American Title Co.</StandardizedName>
      </TitleCompInfo>
      <Mortgage1>
        <RecordingDate></RecordingDate>
        <Type />
        <Amount>0</Amount>
        <LenderFullName />
        <TermDate />
        <InterestRate></InterestRate>
      </Mortgage1>
      <Mortgage2 />
      <Valuation />
    </Record>
  </Records>
</LookupDeedsResponse>
```

--------------------------------

### GET JSON Response Example

Source: https://docs.melissa.com/cloud-api/street-route/street-route-reference-guide.html

Example JSON response for a GET request to find distance and drive time.

```json
{
    "Results": "SR01",
    "Units": "mi",
    "TransmissionResult": "",
    "TravelTime": "00:05:05",
    "TotalDrivingDistance": "1.866595",
    "TransmissionReference": "Test",
    "Version": "1.4.1.0"
}
```

--------------------------------

### Set License and Add Records with Example Values (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/global-ip-package.html

Example of setting the license and adding records with specific IDs and IP addresses. Replace MELISSA_LICENSE_KEY with your license.

```csharp
globalIP.SetLicense(MELISSA_LICENSE_KEY);

globalIP.AddRecord(new GlobalIPRecordRequest
{
  RecordID = "1",
  IPAddress = "12.203.219.6"
});

globalIP.AddRecord(new GlobalIPRecordRequest
{
  RecordID = "2",
  IPAddress = "139.101.81.42"
});
```

--------------------------------

### GET JSON Response Example

Source: https://docs.melissa.com/cloud-api/property/property-reference-guide.html

This is an example of a JSON response for a GET request, typically used for retrieving property deed information.

```json
{
  "Version": "9.4.2.1107",
  "TransmissionReference": "Test",
  "Results": "YS07",
  "TotalRecords": 1,
  "Records": [
    {
      "DocInfo": {
        "RecordingDate": "20221222"
      },
      "TxDefInfo": {
        "TransactionType": "21"
      },
      "TxAmtInfo": {
        "TransferAmount": "0.00"
      },
      "PropertyAddress": {},
      "PrimaryGrantor": {
        "Name1Full": "Mohammad A Jamal",
        "Name2Full": "Farida M Jamal"
      },
      "SecondaryGrantor": {},
      "PrimaryGrantee": {
        "Name1Full": "Rogelio Ramirez",
        "Name2Full": "Kimberly Ramirez"
      },
      "SecondaryGrantee": {},
      "TitleCompInfo": {
        "StandardizedName": "Texas American Title Co."
      },
      "Mortgage1": {
        "RecordingDate": "",
        "Type": "",
        "Amount": "0",
        "LenderFullName": "",
        "TermDate": "",
        "InterestRate": ""
      },
      "Mortgage2": {},
      "Valuation": {}
    }
  ]
}
```

--------------------------------

### GET JSON Response Example

Source: https://docs.melissa.com/on-premise-api/geocoder-container/geocoder-container-reference-guide.html

Example of a JSON response for a GET request. This structure details geocoding results for a given address.

```json
{
  "TransmissionResults": "",
  "TransmissionReference": "test",
  "Version": "8.4.1.17401",
  "TotalRecords": 1,
  "Records": [
    {
      "RecordID": "",
      "Latitude": "33.637562",
      "Longitude": "-117.606887",
      "CensusTract": "032053",
      "CensusBlock": "1002",
      "CountyFIPS": "06059",
      "CountyName": "Orange",
      "PlaceCode": "0659587",
      "PlaceName": "Rancho Santa Margarita",
      "TimeZoneCode": "08",
      "TimeZone": "Pacific Time",
      "CBSACode": "31080",
      "CBSATitle": "Los Angeles-Long Beach-Anaheim, CA",
      "CBSALevel": "Metropolitan Statistical Area",
      "CBSADivisionCode": "11244",
      "CBSADivisionTitle": "Anaheim-Santa Ana-Irvine, CA",
      "CBSADivisionLevel": "Metropolitan Statistical Area",
      "CensusKey": "060590320531002",
      "CensusKeyDecennial": "060590320531005",
      "CountySubdivisionCode": "91977",
      "CountySubdivisionName": "Mission Viejo CCD",
      "ElementarySchoolDistrictCode": "",
      "ElementarySchoolDistrictName": "",
      "SecondarySchoolDistrictCode": "",
      "SecondarySchoolDistrictName": "",
      "StateDistrictLower": "071",
      "StateDistrictUpper": "038",
      "UnifiedSchoolDistrictCode": "07440",
      "UnifiedSchoolDistrictName": "Capistrano Unified School District",
      "BlockSuffix": "",
      "Results": "GS05",
      "StatusCode": "B",
      "SourceLevel": "BC"
    }
  ]
}
```

--------------------------------

### Initialize Data Files and Handle Status

Source: https://docs.melissa.com/on-premise-api/geocoder-object/geocoder-object-quickstart.html

Configure data file paths and initialize the object, checking the ProgramStatus to ensure successful setup.

```C#
// Set data paths for objects
mdGeoObj.SetPathToGeoCodeDataFiles(PATH_TO_DATA_FILES);
mdGeoObj.SetPathToGeoCanadaDataFiles(PATH_TO_DATA_FILES);
mdGeoObj.SetPathToGeoPointDataFiles(PATH_TO_DATA_FILES);
mdGeo.ProgramStatus pStatus = mdGeoObj.InitializeDataFiles();

// Handle potential issues while initializing the data files
if (pStatus != mdGeo.ProgramStatus.ErrorNone)
{
    Console.WriteLine("Fail to Initialize Object.");
    Console.WriteLine(pStatus);
    return;
}
```

```C++
// Set data paths for objects
mdGeoObj->SetPathToGeoCodeDataFiles(PATH_TO_DATA_FILES.c_str());
mdGeoObj->SetPathToGeoCanadaDataFiles(PATH_TO_DATA_FILES.c_str());
mdGeoObj->SetPathToGeoPointDataFiles(PATH_TO_DATA_FILES.c_str());
mdGeo::ProgramStatus pStatus = mdGeoObj->InitializeDataFiles();

if (pStatus != mdGeo::ProgramStatus::ErrorNone)
{
    cout << "Failed to Initialize Object." << endl;
    cout << pStatus << endl;
    return;
}
```

```Java
// Set data paths for objects
mdGeoObj.SetPathToGeoCodeDataFiles(PATH_TO_DATA_FILES);
mdGeoObj.SetPathToGeoCanadaDataFiles(PATH_TO_DATA_FILES);
mdGeoObj.SetPathToGeoPointDataFiles(PATH_TO_DATA_FILES);
mdGeo.ProgramStatus pStatus = mdGeoObj.InitializeDataFiles();

if (pStatus != mdGeo.ProgramStatus.ErrorNone) {
    // Problem during initialization
    System.out.println("Failed to Initialize Object.");
    System.out.println(pStatus);
    return;
}
```

```Python3
# Set data paths for objects
md_geo_obj.SetPathToGeoCodeDataFiles(PATH_TO_DATA_FILES)
md_geo_obj.SetPathToGeoCanadaDataFiles(PATH_TO_DATA_FILES)
md_geo_obj.SetPathToGeoPointDataFiles(PATH_TO_DATA_FILES)
p_status = md_geo_obj.InitializeDataFiles()

if (p_status != mdGeo_pythoncode.ProgramStatus.ErrorNone):
    print("Failed to Initialize Object.")
    print(p_status)
    return
```

--------------------------------

### Set Input Parameters and Add Records Example

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/global-email-package.html

Example usage of setting a license and adding records individually.

```C#
globalEmail.SetLicense(MELISSA_LICENSE_KEY);

globalEmail.AddRecord(
  new GlobalEmailRecordRequest
  {
    RecordID = "1",
    Email = "info@melissa.com"
  }
);

globalEmail.AddRecord(
  new GlobalEmailRecordRequest
  {
    RecordID = "2",
    Email = "test@melissa.com"
  }
);
```

```Python
global_email = GlobalEmail(MELISSA_LICENSE_KEY)

global_email.add_record(GlobalEmailRecordRequest(
  record_id = "1",
  email = "info@melissa.com"
  }
))

global_email.add_record(GlobalEmailRecordRequest(
  record_id = "2",
  email = "test@melissa.com"
))
```

--------------------------------

### DoGeoCode GET Request Example

Source: https://docs.melissa.com/on-premise-api/geocoder-container/geocoder-container-reference-guide.html

Example of a cURL command for performing geocoding via a GET request. Requires a license key and zip code.

```curl
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V4/WEB/Geo/DoGeoCode?\
t=test\
&id={{license_key}}\
&zip=92688\
&dp=82" \
-H "accept: application/json"
```

--------------------------------

### Initialize Data Files

Source: https://docs.melissa.com/on-premise-api/matchup-object-global/matchup-object-global-reference-guide.html

Prepares the MatchUp Object for use by opening necessary data files. Must be called after SetLicenseString and SetPathToMatchUpFiles.

```text
mdMUHybridInitializeDataFiles();
```

--------------------------------

### Initialize Data Files

Source: https://docs.melissa.com/on-premise-api/matchup-object-global/matchup-object-global-reference-guide.html

Opens data files and prepares the MatchUp Object Global. Must be called after SetLicenseString and SetPathToMatchUpFiles.

```text
mdMUReadWriteInitializeDataFiles(String EncodingFormat);
```

--------------------------------

### Example GET Request Parameters

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/street-route-package.html

Example usage of the SetValue method with specific coordinate values.

```C#
streetRoute.SetValue("StartLatitude", "33.637520");
streetRoute.SetValue("StartLongitude", "-117.606920");
streetRoute.SetValue("EndLatitude", "33.649870");
streetRoute.SetValue("EndLongitude", "-117.582960");
```

```Python
street_route.set_value("start_latitude", "33.637520")
street_route.set_value("start_longitude", "-117.606920")
street_route.set_value("end_latitude", "33.649870")
street_route.set_value("end_longitude", "-117.582960")
```

--------------------------------

### Example Parameter Configuration

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/personator-search-package.html

Demonstrates setting specific values for a Personator Search request.

```C#
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");
```

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

--------------------------------

### Get Distance - GET Request Example

Source: https://docs.melissa.com/cloud-api/street-route/street-route-reference-guide.html

Use this GET request to find the distance and drive time between two points. Replace {{customerId}} with your license key.

```curl
curl -X GET "https://streetroute.melissadata.net/v1/WEB/StreetRoute/getDistance?&id={{customerId}}&opt=avoid:tunnels,routeType:shortest&t=Test&units=&endLatitude=33.649870&endLongitude=-117.582960&format=JSON&startLatitude=33.637520&startLongitude=-117.606920" \
-H "Content-Type:application/json" \
-H "Accept:application/json"
```

--------------------------------

### Configure Parameters via Direct Property Access Example

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/smart-mover-package.html

Example implementation showing direct property assignment with populated values.

```C#
smartMover.PafId = PAF_ID;
smartMover.Company = "Melissa";
smartMover.FullName = "Raymond Melissa";
smartMover.AddressLine1 = "22382 Avenida Empresa";
smartMover.City = "Rancho Santa Margarita";
smartMover.State = "CA";
smartMover.Postal = "92688";
smartMover.Country = "US";
```

```Python
smart_mover.paf_id = PAF_ID
smart_mover.company = "Melissa"
smart_mover.full_name =  "Raymond Melissa"
smart_mover.address_line_1 = "22382 Avenida Empresa"
smart_mover.city = "Rancho Santa Margarita"
smart_mover.state = "CA"
smart_mover.postal = "92688"
smart_mover.country = "US"
```

--------------------------------

### GET /v1/doContactVerify

Source: https://docs.melissa.com/cloud-api/personator-identity/personator-identity-reference-guide.html

This GET request example demonstrates how to call the doContactVerify endpoint with query parameters for contact verification.

```APIDOC
## GET /v1/doContactVerify

### Description
This endpoint performs contact verification by executing specified actions and options using GET request parameters.

### Method
GET

### Endpoint
https://globalpersonator.melissadata.net/v1/doContactVerify

### Parameters
#### Query Parameters
- **t** (string) - Optional - Transmission reference.
- **id** (string) - Required - Your Melissa license key.
- **act** (string) - Optional - Specifies the actions to perform (e.g., "check").
- **full** (string) - Optional - The full name to verify.
- **phone** (string) - Optional - The phone number to verify.
- **email** (string) - Optional - The email address to verify.
- **a1** (string) - Optional - The first line of the address.
- **loc** (string) - Optional - The city or locality.
- **admarea** (string) - Optional - The state or administrative area.
- **postal** (string) - Optional - The postal code.
- **ctry** (string) - Optional - The country code.

### Request Example
```curl
curl -X GET "https://globalpersonator.melissadata.net/v1/doContactVerify?\n&t=Test\n&id={{customerId}}\n&act=check\n&full=John%20Smith\n&phone=1-800-635-4772\n&email=info@melissa.com\n&a1=22382%20Avenida%20Empresa\n&loc=Rancho%20Santa%20Margarita\n&admarea=CA\n&postal=92688\n&ctry=US" \n-H "Content-Type: application/json" \n-H "Accept: application/json"
```

### Response
#### Success Response (200)
- **ResponseStatus** (object) - Contains status information about the request.
- **PrimaryResult** (object) - Contains the primary verification results.
- **SecondaryResults** (array) - Contains additional verification results if applicable.

#### Response Example
```json
{
  "ResponseStatus": {
    "Success": true,
    "Errors": [],
    "Warnings": []
  },
  "PrimaryResult": {
    "CustomerID": "{{customerId}}",
    "RecordID": "12345",
    "Status": "Success"
  },
  "SecondaryResults": []
}
```
```

--------------------------------

### Get Distance with Waypoints (GET)

Source: https://docs.melissa.com/cloud-api/street-route/street-route-quickstart.html

This GET request calculates the route distance and drive time between a start point and a destination, including one or more intermediate waypoints. Units can be specified.

```curl
curl -X GET "https://streetroute.melissadata.net/v1/WEB/StreetRoute/getDistanceMultipoint?&id={{customerId}}&opt=avoid:tunnels&t=Test&units=mi&points=42.211479,-70.999908:42.201926,-71.007090:42.211848, -71.019438:42.214976, -71.0045472" \
-H "Content-Type:application/json" \
-H "Accept:application/json"
```

--------------------------------

### Set Post Body with Example Data - Python

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/personator-consumer-package.html

This Python example shows how to set the post body with sample address data. Remember to replace `MELISSA_LICENSE_KEY` with your valid license key.

```python
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"
      )
  ]
))

```

--------------------------------

### Perform SSN Lookup via GET

Source: https://docs.melissa.com/cloud-api/ssn-name-match/ssn-name-match-reference-guide.html

Example of a GET request to the doLookup endpoint. Replace {{customerId}} with your actual license key.

```bash
curl -X GET "https://namessn.melissadata.net/v4/web/SSN/doLookup?\
&format=json\
&id={{customerId}}\
&first=John\
&full=John%20Doe\
&last=Doe\
&ssn=111222333" \
```

--------------------------------

### Example: Set Request Parameters using Specialized Methods (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/token-server-package.html

Example demonstrating how to set package, ip, and time_span using specialized methods.

```python
token_server.set_package("GlobalExpressEntry")
token_server.set_ip("")
token_server.set_time_span("0015")
```

--------------------------------

### Token Server Initialization

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/token-server-package.html

Demonstrates how to initialize the Token Server client using a license key or environment variable.

```APIDOC
## Token Server Initialization

### Description
Initializes the Token Server client with a license key or by reading from environment variables.

### Constructors

#### TokenServer(string license)
Initializes the Cloud API object with a license key.

**Example (C#):**
```csharp
TokenServer tokenServer = new TokenServer("MELISSA_LICENSE_KEY");
```

**Example (Python):**
```python
token_server = TokenServer(MELISSA_LICENSE_KEY)
```

#### TokenServer()
Initializes the Cloud API object, reading the license key from the environment variable **MD_LICENSE** or a configured set method.

**Example (C#):**
```csharp
TokenServer tokenServer = new TokenServer()
```

**Example (Python):**
```python
token_server = TokenServer()
```
```

--------------------------------

### Example GET Request Configuration using SetValue (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/reverse-geocoder-package.html

Example demonstrating how to set Latitude, Longitude, and MaxRecords using the SetValue method.

```csharp
reverseGeoCoder.SetValue("Latitude", "33.637520");
reverseGeoCoder.SetValue("Longitude", "-117.606920");
reverseGeoCoder.SetValue("MaxRecords", "3");
```

--------------------------------

### Submit Remove MIK Request via GET

Source: https://docs.melissa.com/cloud-api/contribution/contribution-reference-guide.html

Example of using a GET request to remove a MIK. Ensure the license key is provided in the id parameter.

```bash
curl -X GET "https://contribution.melissadata.net/V4/WEB/removeMIK?\
&id={{customerId}}\
&t=Test\
&act=delete\
&mik=8008006245\
&respondtoemail=youremail%40melissadata%2Ecom" \
-H "Content-Type:application/json" \
-H "Accept:application/json"
```

--------------------------------

### Example: Set Request Parameters using Specialized Methods (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/token-server-package.html

Example demonstrating how to set Package, Ip, and TimeSpan using specialized methods.

```csharp
tokenServer.SetPackage("GlobalExpressEntry");
tokenServer.SetIP("");
tokenServer.SetTimeSpan("0015");
```

--------------------------------

### Example: Set IP Directly (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/global-ip-package.html

Example demonstrating how to set the IP address to '12.203.219.6' using direct property access.

```python
global_ip.ip = "12.203.219.6"
```

--------------------------------

### Initialize and Make GET Request in Python

Source: https://docs.melissa.com/cloud-api/people-business-search/people-business-search-packages-and-samples.html

Initializes the People Business Search SDK in Python and makes a GET request with specified parameters. Ensure MELISSA_LICENSE_KEY is set.

```python
# Initialize People Business Search
people_business = PeopleBusinessSearch(MELISSA_LICENSE_KEY)

# Set the parameters
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"

# Make the GET request
response_object = people_business.get(PeopleBusinessSearchResponse)

# Access the response value
result_code = response_object.result_code

```

--------------------------------

### GET Request for IP Location

Source: https://docs.melissa.com/cloud-api/global-ip/global-ip-reference-guide.html

Example of a GET request to the doIPLocation endpoint to retrieve IP geolocation data. Ensure to replace `{{customerId}}` with your actual license key.

```curl
curl -X GET "https://globalip.melissadata.net/v4/WEB/iplocation/doiplocation?&t=&id={{customerId}}&ip="216.231.3.166"&format=JSON" -H "Content-Type:application/json" -H "Accept:application/json"
```

--------------------------------

### Matching Project Setup

Source: https://docs.melissa.com/software/unison/unison-components.html

Information on setting up a Matching Project, including naming and privacy options.

```APIDOC
## Matching Project Setup

### Description
Details the initial steps for creating a Matching Project within the Unison platform.

### Steps
1. **Title and Description**
   - **Project Title** (string) - Required. The name for the Matching Project.
   - **Project Description** (string) - Optional. A description for the project.
   - **Make this a private project** (boolean) - Checkbox to make the project private.
```

--------------------------------

### Handle JSON Response

Source: https://docs.melissa.com/cloud-api/business-coder/business-coder-reference-guide.html

Example JSON response structures for GET and POST requests.

```json
{
   "TransmissionResults": "",
   "TransmissionReference": "Test",
   "Version": "7.0.1.1071",
   "TotalRecords": "1",
   "Records":
   [{
      "AddressLine1": "22382 Avenida Empresa",
      "City": "Rancho Santa Margarita",
      "CompanyName": "Melissa Data",
      "CurrentCompanyName": "Melissa Data",
      "MelissaEnterpriseKey": "323318841",
      "PostalCode": "92688-2112",
      "RecordID": "1",
      "Results": "AS01,DA00,DA20,DA30,DA40,DA50,FS01,FS08",
      "State": "CA",
      "Suite": "",
      "TotalContacts": "8"
   }]
}
```

```json
{
   "TransmissionResults": "",
   "TransmissionReference": "Test",
   "Version": "7.0.1.1071",
   "TotalRecords": "1",
   "Records":
   [{
      "AddressLine1": "22382 Avenida Empresa",
      "City": "Rancho Santa Margarita",
      "CompanyName": "Melissa Data",
      "CurrentCompanyName": "Melissa Data",
      "MelissaEnterpriseKey": "323318841",
      "PostalCode": "92688-2112",
      "RecordID": "1",
      "Results": "AS01,DA20,DA30,DA40,DA50,FS01,FS04,GS05",
      "State": "CA",
      "Suite": "",
      "TotalContacts": "8"
   }]
}
```

--------------------------------

### Example: Set Request Parameters using Direct Property Access (Python)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/token-server-package.html

Example demonstrating how to set package, ip, and time_span properties directly.

```python
token_server.package = "GlobalExpressEntry"
token_server.ip = ""
token_server.time_span = "0015"
```

--------------------------------

### Example: Set IP Directly (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/global-ip-package.html

Example demonstrating how to set the IP address to '12.203.219.6' using direct property access.

```csharp
globalIP.IP = "12.203.219.6";
```

--------------------------------

### Perform Contact Verification via GET Request

Source: https://docs.melissa.com/cloud-api/personator-identity/personator-identity-reference-guide.html

Example of how to perform contact verification using the doContactVerify endpoint with GET parameters. Ensure to replace `{{customerId}}` with your actual license key.

```curl
curl -X GET "https://globalpersonator.melissadata.net/v1/doContactVerify?\n&t=Test\n&id={{customerId}}\n&act=check\n&full=John%20Smith\n&phone=1-800-635-4772\n&email=info@melissa.com\n&a1=22382%20Avenida%20Empresa\n&loc=Rancho%20Santa%20Margarita\n&admarea=CA\n&postal=92688\n&ctry=US" \n-H "Content-Type: application/json" \n-H "Accept: application/json"
```

--------------------------------

### Example: Set Request Parameters using Direct Property Access (C#)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/token-server-package.html

Example demonstrating how to set Package, IP, and TimeSpan properties directly.

```csharp
tokenServer.Package = "GlobalExpressEntry";
tokenServer.IP = "";
tokenServer.TimeSpan = "0015";
```

--------------------------------

### Perform a Personator Search (GET JSON)

Source: https://docs.melissa.com/cloud-api/personator-search/personator-search-reference-guide.html

Example of how to perform a consumer search using the doPersonatorSearch endpoint with GET JSON request. Ensure to replace {{customerId}} with your actual license key.

```curl
curl -X GET "https://personatorsearch.melissadata.net/WEB/doPersonatorSearch?\ 
&id={{customerId}}\ 
&format=JSON\ 
&t=Test\ 
&full=Melissa%20Data\ 
&a1=22382%20Avenida%20Empresa\ 
&city=Rancho%20Santa%20Margarita\ 
&state=CA\ 
&postal=92688"
```

--------------------------------

### Initialize and Make POST Request in Python

Source: https://docs.melissa.com/cloud-api/people-business-search/people-business-search-packages-and-samples.html

Initializes the People Business Search SDK in Python and makes a POST request with a set of records. Ensure MELISSA_LICENSE_KEY is set.

```python
# Initialize People Business Search
people_business = PeopleBusinessSearch(MELISSA_LICENSE_KEY)

# Create a set of requests and set their parameters
people_business.add_record(PeopleBusinessSearchRecordRequest
(
    max_records = "10",
    match_level = "10",
    address_line_1 = "22382 Avenida Empresa",
    locality = "RSM",
    administrative_area = "CA",
    postal_code = "92688",
    any_name = "Melissa Data"
))

# Make the POST request
response_object = people_business.post(PeopleBusinessSearchResponse)

# Access the response value
result_code = response_object.result_code

```

--------------------------------

### ContactVerify API - GET Request (XML)

Source: https://docs.melissa.com/cloud-api/personator-consumer/personator-consumer-reference-guide.html

This example demonstrates how to perform a contact verification using a GET request with XML output. It includes parameters for address, city, state, and customer ID.

```APIDOC
## GET /v3/WEB/ContactVerify/doContactVerify

### Description
Performs contact verification and data appending using a GET request. Returns results in XML format.

### Method
GET

### Endpoint
https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify

### Parameters
#### Query Parameters
- **act** (string) - Required - Action to perform (e.g., Append).
- **cols** (string) - Optional - Columns to include in the response.
- **id** (string) - Required - Your customer license key.
- **opt** (string) - Optional - Options for the action (e.g., Append:blank).
- **t** (string) - Optional - Transmission reference.
- **a1** (string) - Optional - Address line 1.
- **a2** (string) - Optional - Address line 2.
- **bday** (string) - Optional - Birth day.
- **bmo** (string) - Optional - Birth month.
- **byr** (string) - Optional - Birth year.
- **city** (string) - Optional - City.
- **comp** (string) - Optional - Company name.
- **ctry** (string) - Optional - Country.
- **email** (string) - Optional - Email address.
- **ff** (string) - Optional - Free form field.
- **first** (string) - Optional - First name.
- **format** (string) - Required - Output format (JSON or XML).
- **full** (string) - Optional - Full name.
- **ip** (string) - Optional - IP address.
- **last** (string) - Optional - Last name.
- **lastline** (string) - Optional - Last line of address.
- **mak** (string) - Optional - Melissa Address Key.
- **phone** (string) - Optional - Phone number.
- **postal** (string) - Optional - Postal code.
- **state** (string) - Optional - State or province.

### Request Example
```bash
curl -X GET "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify?&act=Append&cols=&id={{customerId}}&opt=Append:blank&t=Test&a1=22382%20Avenida%20Empresa&a2=&bday=&bmo=&byr=&city=Rancho%20Santa%20Margarita&comp=&ctry=&email=&ff=&first=&format=XML&full=&ip=&last=&lastline=&mak=&phone=&postal=&state=California" -H "Content-Type: application/xml" -H "Accept: application/xml"
```

### Response
#### Success Response (200)
- **Response fields depend on the `act` and `cols` parameters.**

#### Response Example
```xml
<ContactVerifyResponse>
  <Status>Success</Status>
  <Results>
    <Result>
      <RecordID>1</RecordID>
      <VerifiedAddress>
        <StandardizedAddress>
          <Address1>22382 AVENIDA EMPRESA</Address1>
          <City>RANCHO SANTA MARGARITA</City>
          <State>CA</State>
          <PostalCode>92688</PostalCode>
        </StandardizedAddress>
      </VerifiedAddress>
    </Result>
  </Results>
</ContactVerifyResponse>
```
```

--------------------------------

### Example Parameter Configuration

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/smart-mover-package.html

Set input parameters using the SetValue method with concrete values.

```C#
smartMover.SetValue("PafId", PAF_ID);
smartMover.SetValue("Company", "Melissa");
smartMover.SetValue("FullName", "Raymond Melissa");
smartMover.SetValue("AddressLine1", "22382 Avenida Empresa");
smartMover.SetValue("City", "Rancho Santa Margarita");
smartMover.SetValue("State", "CA");
smartMover.SetValue("Postal", "92688");
smartMover.SetValue("Country", "US");
```

```Python
smart_mover.set_value("paf_id", PAF_ID)
smart_mover.set_value("company", "Melissa")
smart_mover.set_value("full_ame", "Raymond Melissa")
smart_mover.set_value("address_line_1", "22382 Avenida Empresa")
smart_mover.set_value("city", "Rancho Santa Margarita")
smart_mover.set_value("state", "CA")
smart_mover.set_value("postal", "92688")
smart_mover.set_value("country", "US")
```

--------------------------------

### ContactVerify API - GET Request (JSON)

Source: https://docs.melissa.com/cloud-api/personator-consumer/personator-consumer-reference-guide.html

This example demonstrates how to perform a contact verification using a GET request with JSON output. It includes parameters for address, city, state, and customer ID.

```APIDOC
## GET /v3/WEB/ContactVerify/doContactVerify

### Description
Performs contact verification and data appending using a GET request. Returns results in JSON format.

### Method
GET

### Endpoint
https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify

### Parameters
#### Query Parameters
- **act** (string) - Required - Action to perform (e.g., Append).
- **cols** (string) - Optional - Columns to include in the response.
- **id** (string) - Required - Your customer license key.
- **opt** (string) - Optional - Options for the action (e.g., Append:blank).
- **t** (string) - Optional - Transmission reference.
- **a1** (string) - Optional - Address line 1.
- **a2** (string) - Optional - Address line 2.
- **bday** (string) - Optional - Birth day.
- **bmo** (string) - Optional - Birth month.
- **byr** (string) - Optional - Birth year.
- **city** (string) - Optional - City.
- **comp** (string) - Optional - Company name.
- **ctry** (string) - Optional - Country.
- **email** (string) - Optional - Email address.
- **ff** (string) - Optional - Free form field.
- **first** (string) - Optional - First name.
- **format** (string) - Required - Output format (JSON or XML).
- **full** (string) - Optional - Full name.
- **ip** (string) - Optional - IP address.
- **last** (string) - Optional - Last name.
- **lastline** (string) - Optional - Last line of address.
- **mak** (string) - Optional - Melissa Address Key.
- **phone** (string) - Optional - Phone number.
- **postal** (string) - Optional - Postal code.
- **state** (string) - Optional - State or province.

### Request Example
```bash
curl -X GET "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify?&act=Append&cols=&id={{customerId}}&opt=Append:blank&t=Test&a1=22382%20Avenida%20Empresa&a2=&bday=&bmo=&byr=&city=Rancho%20Santa%20Margarita&comp=&ctry=&email=&ff=&first=&format=JSON&full=&ip=&last=&lastline=&mak=&phone=&postal=&state=California" -H "Content-Type: application/json" -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **Response fields depend on the `act` and `cols` parameters.**

#### Response Example
```json
{
  "ContactVerifyResponse": {
    "Status": "Success",
    "Results": [
      {
        "RecordID": "1",
        "VerifiedAddress": {
          "StandardizedAddress": {
            "Address1": "22382 AVENIDA EMPRESA",
            "City": "RANCHO SANTA MARGARITA",
            "State": "CA",
            "PostalCode": "92688"
          }
        }
      }
    ]
  }
}
```
```

--------------------------------

### Configure License and Paths

Source: https://docs.melissa.com/on-premise-api/matchup-object-global/matchup-object-global-reference-guide.html

Set the license string and path to the required data files.

```pseudocode
CALL mu.SetLicenseString with LicenseString
CALL mu.SetPathToMatchUpFiles with PathToMatchUpFiles
```

--------------------------------

### Set Address Components (Example)

Source: https://docs.melissa.com/cloud-api/cloud-api-packages/property-package.html

Example demonstrating how to set address components with specific values. Ensure correct data types and formats.

```csharp
property.SetAddressLine1("22382 Avenida Empresa");
property.SetCity("Rancho Santa Margarita");
property.SetState("CA");
```

```python
property.set_address_line_1("22382 Avenida Empresa")
property.set_city("Rancho Santa Margarita")
property.set_state("CA")
```
Tokens:
Raw