Input Parameters - Identify API

Detailed information on the input parameters used for the Person Identify API

Minimum Inputs

A valid input request to the Identify API must include at least one of the following:

Required Parameters

name

Parameter NameRequiredDescriptionDefaultExample
nameNo*The person's full name, at least first and lastJennifer C. Jackson

first_name

Parameter NameRequiredDescriptionDefaultExample
first_nameNo*The person's first nameJennifer

last_name

Parameter NameRequiredDescriptionDefaultExample
last_nameNo*The person's last nameJackson

location

Parameter NameRequiredDescriptionDefaultExample
locationNo*The location in which a person lives. Can be anything from a street address to a country nameMedford, OR USA

street_address

Parameter NameRequiredDescriptionDefaultExample
street_addressNo*A street address in which the person lives1234 Main Street

locality

Parameter NameRequiredDescriptionDefaultExample
localityNo*A locality in which the person livesBoise

region

Parameter NameRequiredDescriptionDefaultExample
regionNo*A state or region in which the person livesIdaho

postal_code

Parameter NameRequiredDescriptionDefaultExample
postal_codeNo*The postal code in which the person lives. If there is no value for country the postal code is assumed to be US83701

company

Parameter NameRequiredDescriptionDefaultExample
companyNo*A name, website, or social url of a company where the person has workedAmazon Web Services

school

Parameter NameRequiredDescriptionDefaultExample
schoolNo*A name, website, or social url of a university or college the person has attendeduniversity of iowa

phone

Parameter NameRequiredDescriptionDefaultExample
phoneNo*A phone number the person has used in any format.+1 555-234-1234

email

Parameter NameRequiredDescriptionDefaultExample
emailNo*An email the person has used[email protected]

email_hash

Parameter NameRequiredDescriptionDefaultExample
email_hashNo*A sha256 or md5 email hashe206e6cd7fa5f9499fd6d2d943dcf7d9c1469bad351061483f5ce7181663b8d4

profile

Parameter NameRequiredDescriptionDefaultExample
profileNo*A social profile the person has used List of available social profiles.https://linkedin.com/in/seanthorne

lid

Parameter NameRequiredDescriptionDefaultExample
lidNo*A LinkedIn numerical ID145991517

Optional Parameters

middle_name

Parameter NameRequiredDescriptionDefaultExample
middle_nameNoThe person's middle nameCassandra

country

Parameter NameRequiredDescriptionDefaultExample
countryNoA country in which the person livesUnited States

birth_date

Parameter NameRequiredDescriptionDefaultExample
birth_dateNoThe person's birth date. Either the year, or a full birth date35339

required

Parameter NameRequiredDescriptionDefaultExample
requiredNoParameter specifying the fields and data points a response must have to return a 200experience AND work_email

titlecase

Parameter NameRequiredDescriptionDefaultExample
titlecaseNoAll text in the data of API responses is returned as lowercase by default. Setting titlecase to true will titlecase the person data in 200 responses.falsetrue

data_include

Parameter NameRequiredDescriptionDefaultExample
data_includeNoA comma-separated string of fields that you would like the response to include. eg. "names.clean,emails.address". Begin the string with a - if you would instead like to exclude the specified fields. If you would like to exclude all data from being returned, use data_include="".Nonefull_name,emails.address

include_if_matched

Parameter NameRequiredDescriptionDefaultExample
include_if_matchedNoIf set to true, includes a top-level (alongside "data", "status", etc) field "matched" which includes a value for each queried field parameter that was "matched-on" during our internal query.falsetrue

pretty

Parameter NameRequiredDescriptionDefaultExample
prettyNoWhether the output should have human-readable indentation.falsetrue

api_key

Parameter NameRequiredDescriptionDefaultExample
api_keyNoNot required as part of the request parameters, but if not provided here, then it must be provided in the headers using the x-api-key field. For more information see the Authentication page.NoneNice try - don't share your API keys!


Did this page help you?