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 last.)Jennifer C. Jackson

first_name

Parameter NameRequiredDescriptionDefaultExample
first_nameNo*The person's first name.Jennifer

last_name

Parameter NameRequiredDescriptionDefaultExample
last_nameNo*The person's last name.Jackson

location

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

street_address

Parameter NameRequiredDescriptionDefaultExample
street_addressNo*The street address at which the person lives.1234 Main Street

locality

Parameter NameRequiredDescriptionDefaultExample
localityNo*The locality in which the person lives.Boise

region

Parameter NameRequiredDescriptionDefaultExample
regionNo*The state or region in which the person lives.Idaho

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 in the US.83701

company

Parameter NameRequiredDescriptionDefaultExample
companyNo*The name, website or social url of a company where the person has worked.Amazon Web Services

school

Parameter NameRequiredDescriptionDefaultExample
schoolNo*The name, website or social url of a university or college the person has attended.university 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 hash.e206e6cd7fa5f9499fd6d2d943dcf7d9c1469bad351061483f5ce7181663b8d4

profile

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

lid

Parameter NameRequiredDescriptionDefaultExample
lidNo*The LinkedIn numerical ID.145991517

Optional Parameters

middle_name

Parameter NameRequiredDescriptionDefaultExample
middle_nameNoThe person's middle name.Cassandra

country

Parameter NameRequiredDescriptionDefaultExample
countryNoThe country in which the person lives.United States

birth_date

Parameter NameRequiredDescriptionDefaultExample
birth_dateNoThe person's birth date: either the year or a full birth date.35339

titlecase

Parameter NameRequiredDescriptionDefaultExample
titlecaseNoAll text in API responses is returned as lowercase by default. Setting titlecase to true will titlecase the person data in 200 responses.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.None


Did this page help you?