What is the Unlock People API?

The Unlock People API allows you to unlock profile information for individuals by using a combination of filters such as first name, last name, company, full address, job title etc. It goes beyond the basic search results to provide verified contact details, social links, and other professional data that help you understand your target audience.

Does using this API consume credits?

Yes, each unlock request consumes 1 credit per record processed.
Credits are deducted page-wise, meaning:
Credits are used only when you enrich a new page of results.
If you go back to a page you’ve already enriched, no additional credits will be deducted for those same records. Credits are only consumed when enrichment is successful that is, when a record is matched and data is returned.

How can I unlock a profile?

You can unlock profiles in two ways:

Option 1: Using Unique Identifiers

Provide at least one of the following:

filter	Description
people_id	Factori assigned unique Id for an Individual
personal_email_address	Personal Email Address in raw format
personal_email_sha1	Personal Email Address in sha128 format
personal_email_sha2	Personal Email Address in sha256 format
personal_email_md5	Personal Email Address in md5 format
work_email_address	Work Email Address in raw fomat
work_email_sha1	Work Email Address in sha128 format
work_email_sha2	Work Email Address in sha256 format
work_email_md5	Work Email Address in md5 format
phone_number	Phone Number in raw format
phone_number_sha1	Phone Number in sha128 format
phone_number_sha2	Phone Number in sha256 format
phone_number_md5	Phone Number in md5 format
linkedin_url	Full LinkedIn URL
facebook_url	Full Facebook URL
twitter_url	Full Twitter URL
maid	Mobile Advertisement ID in raw format
maid_sha1	Mobile Advertisement ID in sha128 format
maid_sha2	Mobile Advertisement ID in sha256 format
maid_md5	Mobile Advertisement ID in md5 format

Option 2: Using Name Filters + Additional Filters

Provide at least one of the following:

Filter	Description
first_name	Full Name of the Individual
last_name	Last Name of the Individual

AND

Provide at least one of the following:

Filter	Description
company_name	Name of the Company
city	City
street	Street
zip	Postal Code Field
company_linkedinurl	Full Company LinkedIn URL
gender	Gender of the Individual
age	Age of the Individual
full_address	Full Address
employee_title	Job title of the Employee For ex. "field auditor"
employee_job_function	Job Function of the Employee For ex. "account management"
employee_level	Employee Job Level For ex. "VP_LEVEL"

What does the Unlock People API return?

By default, the API returns the entire unlocked profile of the individual including all available data fields in our Data Schema.
If you don’t need the full profile, you can use our output_field_group. In that case, the response will include the basic profile information along with output_fields you specify.

Your can provide one more of the following output_fields:

output_field_group	output_fields
social	`linkedin_url`, `facebook_url`, `twitter_url`
phone	`phone_number`, `phone_sha1`, `phone_sha2`, `phone_md5`, `is_cellphone`, `is_landline`, `carrier`, `phone_last_seen` , `is_workphone`
devices	`device_type`, `maid`, `maid_sha1`, `maid_sha2`, `maid_md5`
emails	`personal_email_address`, `personal_email_sha1`, `personal_email_sha2`, `personal_email_md5` , `personal_ip` , `personal_url`, `personal_email_domain work_email_address`, `work_email_sha1`, `work_email_sha2`, `work_email_md5`, `work_ip`, `work_url`, `work_email_domain`
address	`full_address`, `primary_address`, `city`, `state`, `zip`, `zip4`, `delivery_point_bar_code`, `carrier_route`, `walk_sequence_code`, `fips_state_code`, `fips_county_code`, `county_name`, `latitude`, `longitude`, `address_type`, `metropolitan_statistical_area`, `core_based_statistical_area`, `census_tract`, `census_block`, `census_block_group`, `pre_address`, `street`, `post_address`, `address_suffix`, `address_secondline`, `address_abrev`
education	`education_level`, `education_history`
employment	`employee_title`, `employee_level`, `employee_job_function`, `employee_department`, `skills`, `recent_job_change`, `work_experience`
company	`company_id`, `company_name`, `company_description`, `technologies_used`, `office_address`, `office_city`, `office_county`, `office_state`, `office_zip5`, `office_zip4`, `office_carrier_route`, `office_latitude`, `office_longitude`, `office_cbsa_code`, `office_census_block_group`, `office_census_tract`, `office_county_code`, `company_phone`, `company_credit_score`, `company_csa_code`, `company_dpbc`, `company_franchiseflag`, `company_facebookurl`, `company_linkedinurl`, `company_twitterurl`, `company_website`, `company_fortune_rank`, `company_headquarters_branch`, `company_home_business`, `company_industry`, `company_num_pcs_used`, `company_firm_individual` `company_num_employees`, `company_msa`, `company_msa_name`, `company_naics_code`, `company_naics_description`, `company_naics_code2`, `company_naics_description2`, `company_sic_code2`, `company_sic_code2_description`, `company_sic_code4`, `company_sic_code4_description`, `company_sic_code6`, `company_sic_code6_description`, `company_sic_code8`, `company_sic_code8_description`, `company_parent_company`, `company_parent_company_location`, `company_residential_business_code` `company_subsidiary_company`, `company_revenue_range`, `company_revenue_at_site_code` `company_revenue`, `company_sales_volume`, `company_small_business`, `company_stock_ticker`, `company_year_founded`, `company_minorityowned`, `company_female_owned_or_operated`, `company_franchise_code`, `company_dma`, `company_dma_name`, `company_hq_address`, `company_hq_city`, `company_hq_duns`, `company_hq_state`, `company_hq_zip5`, `company_hq_zip4`, `company_sector`, `company_duns_number`, `company_government_type`, `company_is_topchain` `company_public_private`
financial	`net_worth` , `credit_lines` `credit_card_user`, `newly_issued_credit_card_user`, `credit_range_new`, `credit_cards`, `credit_rating` `loan_to_value`, `loan_date`, `mortgage_loan_type`, `mortgage_rate`, `mortgage_lender`, `mortgage_lender_code`, `mortgage_loan2_amount`, `mortgage_loan2_type`, `mortgage_loan2_lender`, `mortgage_loan2_lender_code`, `mortgage_loan2_rate`, `mortgage_loan2_ratetype` , `lender_code_of_home_purchase`
household	`household_id`, `household_size`, `occupation_home_office`, `dwell_type`, `marital_status`, `length_of_residence`, `number_of_kids`, `pre_school_kids`, `single_parent`, `working_women_in_house_hold`, `homeowner`, `children`, `adults`, `generations`, `census_median_household_income`, `household_income`
property	`general_home_value`, `home_market_value`, `census_median_home_value`, `property_build_year`, `property_with_ac`, `property_with_pool`, `property_with_sewer`, `property_with_water`, `property_fuel_type`
hobby	`hobby`
buyer	`buyer`
donor	`donor`
investor	`investor`
interests	`interests`

200

400Bad Request

401Unauthorized

402Insufficient Credits

409Unlock In Progress