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:
profile
email
phone
email_hash
lid
street_address
locality
region
company
school
location
postal_code
name
first_name
ANDlast_name
Required Parameters
name
name
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
name | No* | The person's full name (at least first and last.) | Jennifer C. Jackson |
first_name
first_name
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
first_name | No* | The person's first name. | Jennifer |
last_name
last_name
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
last_name | No* | The person's last name. | Jackson |
location
location
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
location | No* | The location in which a person lives, which can be anything from a street address to a country name. | Medford, OR USA |
street_address
street_address
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
street_address | No* | The street address at which the person lives. | 1234 Main Street |
locality
locality
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
locality | No* | The locality in which the person lives. | Boise |
region
region
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
region | No* | The state or region in which the person lives. | Idaho |
postal_code
postal_code
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
postal_code | No* | 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
company
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
company | No* | The name, website or social url of a company where the person has worked. | Amazon Web Services |
school
school
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
school | No* | The name, website or social url of a university or college the person has attended. | university of iowa |
phone
phone
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
phone | No* | A phone number the person has used in any format. | +1 555-234-1234 |
email
email
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
email | No* | An email the person has used. | [email protected] |
email_hash
email_hash
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
email_hash | No* | A sha256 or md5 email hash. | e206e6cd7fa5f9499fd6d2d943dcf7d9c1469bad351061483f5ce7181663b8d4 |
profile
profile
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
profile | No* | The social profile the person has used List of available social profiles. | https://linkedin.com/in/seanthorne |
lid
lid
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
lid | No* | The LinkedIn numerical ID. | 145991517 |
Optional Parameters
middle_name
middle_name
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
middle_name | No | The person's middle name. | Cassandra |
country
country
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
country | No | The country in which the person lives. | United States |
birth_date
birth_date
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
birth_date | No | The person's birth date: either the year or a full birth date. | 35339 |
titlecase
titlecase
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
titlecase | No | All text in API responses is returned as lowercase by default. Setting titlecase to true will titlecase the person data in 200 responses. | false | true |
pretty
pretty
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
pretty | No | Whether the output should have human-readable indentation. | false | true |
api_key
api_key
Parameter Name | Required | Description | Default | Example |
---|---|---|---|---|
api_key | No | Not 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 |
Updated 3 days ago
Did this page help you?