Input Parameters
API Fields
The following are the list of attributes that can used to filter the People data
- filters in Factori APIs help you provide filters based on which you will be receiving data of individuals
- output_fields in Factori Unlock API help you receive only those attributes that are useful to you instead of receiving all attributes in the response. For example, "output_fields": ["social", "phone"] means to say that if a record matches a given criteria return only the social info and the phone info.
- must_contain in Factori APIs help you in fetching a specific record if and only if a value exists for that key. For example, "must_contain": "email" means to say that the API needs to fetch a record only if the record contains values for phone numbers and emails
- must_not_contain in Factori APIs help you exclude people based on some criteria. In the below example the API response will exclude People with a
"people_id": "123"
- must_not_contain in Factori APIs help you exclude people based on some criteria. In the below example the API response will exclude People with a
"must_not_contain": {
"people_id": ["123"]
}- page_no in Factori APIs will help you navigate the response using pagination
- All emails are lowercase and empty spaces are trimmed before hashing.
- All phone numbers have their extensions trimmed and don't have any hyphen (-) . Also empty spaces are trimmed before hashing. Our inputs accept phone numbers without extensions, spaces and hyphens.
- All maids end are lowercase and empty spaces are trimmed before hashing.
- Factori APIs accept
full_addressin the standard format specified by the USPS. - Any
address_suffixmentioned in the address should be as present in - https://pe.usps.com/text/pub28/28apc_002.htm - Factori APIs accept only abbreviations for States as mentioned in - https://about.usps.com/who/profile/history/state-abbreviations.htm
- Factori APIs accept "Male" and "Female" as values for gender.
- Factori APIs follow standard SIC codes as mentioned in https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list
- Factori APIs follow standard NAICS codes as mentioned in https://www.census.gov/naics/?58967?yearbck=2022
- net_worth field in Factori APIs accept the following ranges for filtering based on an individual's net worth
| Sl no | Net Worth |
|---|---|
| 1. | "Less_than_$1" |
| 2. | "$1_$4999" |
| 3. | "$5000_$9999" |
| 4. | "$10000_$24999" |
| 5 | "$25000_$49999" |
| 6 | "$50000_$99999" |
| 7 | "$100000_$249999" |
| 8 | "$250000_$499999" |
| 9 | "Greater_than_$499999" |
- household_income field in Factori APIs accept the following ranges
| Sl no | Household income |
|---|---|
| 1 | "Under_$10000" |
| 2 | "$10000_$14999" |
| 3 | "$15000_$19999" |
| 4 | "$20000_$24999" |
| 5 | "$25000_$29999" |
| 6 | "$30000_$34999" |
| 7 | "$35000_$39999" |
| 8 | "$40000_$44999" |
| 9 | "$45000_$49999" |
| 10 | "$50000_$54999" |
| 11 | "$55000_$59999" |
| 12 | "$60000_$64999" |
| 13 | "$65000_$74999" |
| 14 | "$75000_$99999" |
| 15 | "$100000_$149999" |
| 16 | "$150000_$174999" |
| 17 | "$175000_$199999" |
| 18 | "$200000_$249999") |
| 19 | "$250000_Above" |
Here is the table showing different credit rating range
| Sl. No | Credit Rating Range |
|---|---|
| 1 | Above 800 |
| 2 | 750 - 799 |
| 3 | 700 - 749 |
| 4 | 650 - 699 |
| 5 | 600 - 649 |
| 6 | 550 - 599 |
| 7 | 500 - 549 |
| 8 | Below 499 |
Here is the table showing how employee level are represented:
| Sl. No | Employee Level |
|---|---|
| 1 | CONSULTANT |
| 2 | C_LEVEL |
| 3 | DIRECTOR_LEVEL |
| 4 | VP_LEVEL |
| 5 | MANAGER_LEVEL |
| 6 | STAFF |
Here is the table with the serial number and address directions:
| Sl. No | Address Direction |
|---|---|
| 1 | E |
| 2 | N |
| 3 | NE |
| 4 | NW |
| 5 | S |
| 6 | SE |
| 7 | SW |
| 8 | W |
Types
1. Search
The People Search API is your tool for exploring our People database. It allows you to discover and build highly targeted contact lists based using filters such as company name , job title, net worth, and more. Whether you’re identifying potential leads, researching professionals, or enriching your CRM, this API helps you quickly surface relevant profiles
Filters to Search People Data
| Category | Filter Attribute | Data Type | Description / Example Value |
|---|---|---|---|
| Factori | people_id | String | The unique ID for the Individual. |
| General | first_name | String | "ananya" |
| General | last_name | String | "jayaprakash" |
| General | gender | Enum (String) | "F" (Allowed: M, F) |
| General | age | String | "50" |
| Date of Birth | dob_year | String | "2002" |
| Date of Birth | dob_month | String | "May" |
| Date of Birth | dob_day | String | "19" |
| Household | household_id | String | The unique ID for the household. |
| Phone | phone_number | String | Raw phone number: "3387585869694" |
| personal_email_address | String | Raw personal email: "[email protected]" | |
| work_email_address | String | Raw work email: "[email protected]" | |
| Social | linkedin_url | String | Full url "https://www.linkedin.com/..." |
| Social | facebook_url | String | Full url "https://www.facebook.com/..." |
| Social | twitter_url | String | Full url "https://twitter.com/..." |
| Devices | maid | String | Mobile Advertisement ID (raw). |
| Devices | maid_sha1 | String | Hashed Mobile Advertisement ID. |
| Devices | maid_sha2 | String | Hashed Mobile Advertisement ID. |
| Devices | maid_md5 | String | Hashed Mobile Advertisement ID. |
| Phone | phone_number_sha1 | String | Hashed phone number. |
| Phone | phone_number_sha2 | String | Hashed phone number. |
| Phone | phone_number_md5 | String | Hashed phone number. |
| personal_email_sha1 | String | Hashed personal email. | |
| personal_email_sha2 | String | Hashed personal email. | |
| personal_email_md5 | String | Hashed personal email. | |
| work_email_sha1 | String | Hashed work email. | |
| work_email_sha2 | String | Hashed work email. | |
| work_email_md5 | String | Hashed work email. | |
| Address | full_address | String | Full-text search on the entire address. |
| Address | pre_address | String (Enum) | Directional prefix, e.g., "N", "SW". |
| Address | street | String | "acorn" |
| Address | address_suffix | String | Street suffix, e.g., "AVE", "BLVD". |
| Address | post_address | Enum (String) | Directional postfix, e.g., "E", "NW". |
| Address | city | String | "denver" |
| Address | state | String | "California" |
| Address | zip | String | "4987587" |
| Address | latitude | String | Latitude |
| Address | longitude | String | Longitude |
| Address | radius | Integer | Radius -> area around lat - long (Min 100m, Max 10Km) |
| Household | household_income | Enum (String) | "$150000_$174999" |
| Financial | net_worth | Enum (String) | "$5000_$9999" |
| Financial | credit_rating | Enum (String) | "BETWEEN_600_649" |
| Employment | employee_title | String | "field auditor" |
| Employment | employee_department | String | "Marketing" |
| Employment | employee_level | Enum (String) | "VP_LEVEL" |
| Employment | employee_job_function | String | "finance and administration" |
| Company | company_id | String | The unique ID for the company. |
| Company | company_name | String | "community college of denver" |
| Company | company_industry | String | "Education" |
| Company | company_city | String | "denver" |
| Company | company_state | String | "CO" |
| Company | company_linkedinurl | String | The company's LinkedIn profile URL. |
| Company | company_sic_code | String | "8222" |
| Company | company_naics_code | String | "611210" |
Example
An example of a Search Request
curl --location 'https://api.factori.ai/v3/people/search' \
--header 'Content-Type: application/json' \
--header 'x-factori-apikey: <API-Key>' \
--data '{
"filters": {
"first_name": "sunil",
"gender": "M"
},
"must_contain": ["homeowner"],
"must_not_contain" : {
"people_id": ["1"]
},
"page_no": 1,
"page_size": 10
}'2. Unlock
The Unlock People API allows you to access enriched profile information for individuals by using a combination of filters such as name, company, full address, or job title. 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.
Filters to Unlock People Data
Option 1: Users must select at least one of the following:
| Category | Filter Attribute | Data Type | Description / Example Value |
|---|---|---|---|
| Factori | people_id | String | The unique ID for the individual. |
| personal_email_address | String | Raw personal email: "[email protected]" | |
| Phone | phone_number | String | Raw phone number: "3387585869694" |
| Social | linkedin_url | String | Full url "https://www.linkedin.com/..." |
| Social | facebook_url | String | Full url "https://www.facebook.com/..." |
| Social | twitter_url | String | Full url "https://twitter.com/..." |
| Devices | maid | String | Mobile Advertisement ID (raw). |
| Devices | maid_sha1 | String | Hashed Mobile Advertisement ID. |
| Devices | maid_sha2 | String | Hashed Mobile Advertisement ID. |
| Devices | maid_md5 | String | Hashed Mobile Advertisement ID. |
| Phone | phone_number_sha1 | String | Hashed phone number. |
| Phone | phone_number_sha2 | String | Hashed phone number. |
| Phone | phone_number_md5 | String | Hashed phone number. |
| personal_email_sha1 | String | Hashed personal email. | |
| personal_email_sha2 | String | Hashed personal email. | |
| personal_email_md5 | String | Hashed personal email. | |
| work_email_address | String | Raw work email address | |
| work_email_sha1 | String | Hashed work email. | |
| work_email_sha2 | String | Hashed work email. | |
| work_email_md5 | String | Hashed work email. |
Option 2 :
Users must select at least one of the following:
| Category | Filter Attribute | Data Type | Description / Example Value |
|---|---|---|---|
| General | first_name | String | "Mark" |
| General | last_name | String | "Tucker" |
**AND ** Users must select at least one of the following:
| Category | Filter Attribute | Data Type | Description / Example Value |
|---|---|---|---|
| Company | company_name | String | "community college of denver" |
| Address | city | String | "denver" |
| Address | street | String | "acorn" |
| Address | zip | String | "4987587" |
| Company | company_linkedinurl | String | The company's LinkedIn profile URL. |
| General | gender | Enum (String) | "F" (Allowed: M, F) |
| General | age | String | “50” |
| Address | full_address | String | Full-text search on the entire address. |
| Employment | employee_title | String | "field auditor" |
| Employment | employee_job_function | String | "finance and administration" |
| Employment | employee_level | Enum (String) | “VP_LEVEL” |
| Address | latitude | String | Latitude |
| Address | longitude | String | Longitude |
| Address | radius | Integer | Radius -> area around lat - long (Min 100m, Max 10Km) |
An example of an Unlock Request
curl --location 'https://api.factori.ai/v3/people/unlock' \
--header 'Content-Type: application/json' \
--header 'x-factori-apikey: <API-Key>' \
--data '{
"filters": {
"first_name": "sunil",
"company_name": "google"
},
"output_fields": [
"social",
"email",
],
"page_no": 1,
"page_size": 10
}'Updated 5 days ago
