# Search individual person information

The service requires at least one of the following input combinations:

Set A - a1, postal

Set B - a1, city, state

Set C - ff

Set D - last

Set E - phone

Set F - email

Set G - mak

Set H - mik

Endpoint: GET /doPersonatorSearch

## Header parameters:

  - `Accept` (string, required)
    Format of the response.
    Enum: "application/json", "*/*"

  - `Content-Type` (string, required)
    Format of the request.
    Enum: "application/json", "application/xml"

## Query parameters:

  - `t` (string)
    Transmission reference - Serves as a unique request identifier.
    Example: "Test"

  - `format` (string)
    Desired format of the response.
    Enum: "JSON", "XML"

  - `id` (any, required)
    Required. The License Key issued by Melissa.
    Example: "{REPLACE-WITH-YOUR-LICENSE-KEY}"

  - `opt` (string)
    Options - List options in the following format, with multiple options delimited with a , (comma).

OptionName:Parameter,OptionName:Parameter

- AgeRange: - Sets the range of ages returned. Default will return all ages.
If a record does not have a birth date or age, that record will not be returned.
- MaxEmail: - Sets the maximum number of emails that can be returned. Default maximum is '3' if this option is not set.
- MaxPhone: - Sets the maximum number of phone numbers that can be returned. Default maximum is '3' if this option is not set.
- NameHint: - Sets the name hint for the input name. Default is 'varying'.
- Page: - Specifies which "page" to return for a given request. Your "page" length is set by RecordsPerPage. If your request returns more than your RecordsPerPage, these records will be split into "pages". Use this option to select which "page" to view. If your specified "page" is out of the range of possible "page" numbers, an error will be returned. This option is ignored if the option ReturnAllPages is set to true.
- RecordsPerPage: - Specifies how many records are in a "page". The default value is '5'. This option is ignored if the option ReturnAllPages is set to true.
- ReturnAllPages: - Specifies whether to return all pages of results or just the first page.
- SearchConditions: - Specifies the type of search conditions to use when returning records. Only the populated input fields will be compared. A 'strict' search condition is used by default.
- SearchType: - This options allows you to specify the type of search to perform. Default is 'Auto'.
- ShowAllRecords:[None] - This options allows you to return historical/outdated information records that have not been verified in recent sources. While more information is returned, not all information may be as accurate.
- SortBy: - Allows sorting records in a particular order. If ascending or descending is not specified, the default order will be ascending.

  - `cols` (string)
    Columns - The column names or groups to be output
- PreviousAddress - This returns as PreviousAddresses array containing previous address objects.
- DateOfBirth - This field returns as part of the respective record object in the Records array.
- DateOfDeath - This field returns as part of the respective record object in the Records array.
- Email - This field returns as an EmailRecords array containing the email field.
- MelissaIdentityKey - This field returns a unique key associated with a person.
- MoveDate - This field returns as part of the CurrentAddress object.
- Phone - This field returns as an PhoneRecords array containing the phoneNumber field.
- Suffix - This field returns any part of the name that follows the family name.

  - `a1` (string, required)
    The input field for the address. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.
    Example: "22382 Avenida Empresa"

  - `ageapprox` (string)
    Age approximate - Filter results to return individuals who are within a year of the provided age

  - `agegt` (string)
    Age greater than - Filter results to return individuals who’s age is greater than the provided age.

  - `agelt` (string)
    Age less than - Filter results to return individuals who’s age is less than the provided age.

  - `bday` (string)
    The birth day for the record in DD format. Entering the Birth Day will filter results to return only when the day of birth matches.

  - `bmonth` (string)
    The birth month for the record in MM format. Entering the Birth Month will filter results to return only when the month of birth matches.

  - `byear` (string)
    The birth year for the record in YYYY format. Entering the Birth Year will filter results to return only when the year of birth matches.

  - `city` (string, required)
    The city.
    Example: "Rancho Santa Margarita"

  - `email` (string)
    The email address.

  - `ff` (string)
    Free Form Input - Accepts delimited or undelimited free form input. This will be parsed by the service.

  - `first` (string)
    The first name.

  - `full` (string, required)
    The full name.
    Example: "Melissa Data"

  - `last` (string)
    The last name.

  - `mak` (string)
    Melissa Address Key (MAK) - A proprietary unique key identifier for an address

  - `mik` (string)
    Melissa Individual Key (MIK) - A proprietary unique key identifier for an individual. Each individual is assigned a unique MIK number in the Melissa Personator Database.

  - `phone` (string)
    The phone number.

  - `postal` (string, required)
    The postal code or zip code.
    Example: "92688"

  - `state` (string, required)
    The state name.
    Example: "CA"

## Response 200 fields (application/json):

  - `TransmissionResults` (string)
    This is a string value that lists result codes from the web service. For more information, see [Personator Search Result Codes](https://docs.melissa.com/cloud-api/personator-search/result-codes.html).

  - `TransmissionReference` (string)
    A pass-through of the input TransmissionReference field.

  - `TotalPages` (string)
    This is a string value containing the number of total pages returned by the request. The amount of records per page is set within the RecordsPerPage option.

  - `TotalRecords` (string)
    This is a string value containing the number of total records returned by the request, up to a maximum of 500.

  - `Version` (string)
    This is a string value that is the current revision number of Personator Search web service.

  - `Records` (array)

  - `Records.RecordID` (string)
    This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.

  - `Records.Results` (string)
    This is a string value that lists result codes for the most recent request as a whole. For more information, see [Personator Search Result Codes](https://docs.melissa.com/cloud-api/personator-search/result-codes.html).

  - `Records.FullName` (string)
    Returns the full name.

  - `Records.FirstName` (string)
    Returns the first name.

  - `Records.MiddleName` (string)
    Returns the middle name.

  - `Records.LastName` (string)
    Returns the last name.

  - `Records.Suffix` (string)
    This returns any part of the name that follows the family name, such as degrees (“MD” or “PhD”) and generational indicators (“IV” or “Jr.”)

  - `Records.DateOfBirth` (string)
    Returns the date of birth in the format YYYYMM. Accuracy is only to the month.

  - `Records.DateOfDeath` (string)
    This is a string value of the date of death of the individual. YYYYMMDD Format.

  - `Records.MelissaIdentityKey` (string)
    Returns a unique key associated with a person.

  - `Records.CurrentAddress` (object)
    The current address in an object container.

  - `Records.CurrentAddress.AddressLine1` (string)
    Returns address line 1.

  - `Records.CurrentAddress.Suite` (string)
    Returns the suite.

  - `Records.CurrentAddress.City` (string)
    Returns the city.

  - `Records.CurrentAddress.State` (string)
    State name of the current address.

  - `Records.CurrentAddress.PostalCode` (string)
    Postal code of the current address.

  - `Records.CurrentAddress.Plus4` (string)
    Plus4 of the current address.

  - `Records.CurrentAddress.MelissaAddressKey` (string)
    Returns a unique key associated with an address.

  - `Records.CurrentAddress.MelissaAddressKeyBase` (string)
    A unique key assigned to the base address of a complex with apartments or suites.

  - `Records.CurrentAddress.MoveDate` (string)
    Returns the date the individual moved-in to this address in the format YYYYMMDD.

  - `Records.PreviousAddresses` (array)
    This is an array container holding the previous address objects.

  - `Records.PreviousAddresses.AddressLine1` (string)
    Returns address line 1.

  - `Records.PreviousAddresses.City` (string)
    Returns the city.

  - `Records.PreviousAddresses.MelissaAddressKey` (string)
    Returns a unique key associated with an address.

  - `Records.PreviousAddresses.MelissaAddressKeyBase` (string)
    Returns a unique key associated with a building containing multiple suites/apartments.

  - `Records.PreviousAddresses.Plus4` (string)
    Plus4 of the current address.

  - `Records.PreviousAddresses.PostalCode` (string)
    Postal code of the current address.

  - `Records.PreviousAddresses.State` (string)
    State name of the current address.

  - `Records.PreviousAddresses.Suite` (string)
    Returns the suite.

  - `Records.PreviousAddresses.MoveDate` (string)
    Returns the date the individual moved-out from this address in the format YYYYMMDD.

  - `Records.EmailRecords` (array)
    This is an array container holding the email record objects.

  - `Records.EmailRecords.email` (string)
    Returns the email address associated with the individual.

  - `Records.PhoneRecords` (array)
    This is an array container holding the phone record objects.

  - `Records.PhoneRecords.phoneNumber` (string)
    Returns the standardized phone number for the record.

## Response 400 fields (application/json):

  - `type` (string)
    The type of error that occurred.

  - `title` (string)
    A short summary of the error.

  - `status` (integer)
    The HTTP status code for the error.

  - `errors` (object)

  - `errors.$.<PropertyName>` (array)
    A detailed message about the error.

  - `traceId` (string)
    A unique identifier for the request, useful for debugging.