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": {
	"people_id": ["123"]
}
Sl noNet 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 noHousehold 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. NoCredit Rating Range
1Above 800
2750 - 799
3700 - 749
4650 - 699
5600 - 649
6550 - 599
7500 - 549
8Below 499

Here is the table showing how employee level are represented:

Sl. NoEmployee Level
1CONSULTANT
2C_LEVEL
3DIRECTOR_LEVEL
4VP_LEVEL
5MANAGER_LEVEL
6STAFF

Here is the table with the serial number and address directions:

Sl. NoAddress Direction
1E
2N
3NE
4NW
5S
6SE
7SW
8W

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

CategoryFilter AttributeData TypeDescription / Example Value
Factoripeople_idStringThe unique ID for the Individual.
Generalfirst_nameString"ananya"
Generallast_nameString"jayaprakash"
GeneralgenderEnum (String)"F" (Allowed: M, F)
GeneralageString"50"
Date of Birthdob_yearString"2002"
Date of Birthdob_monthString"May"
Date of Birthdob_dayString"19"
Householdhousehold_idStringThe unique ID for the household.
Phonephone_numberStringRaw phone number: "3387585869694"
Emailpersonal_email_addressStringRaw personal email: "[email protected]"
Emailwork_email_addressStringRaw work email: "[email protected]"
Sociallinkedin_urlStringFull url "https://www.linkedin.com/..."
Socialfacebook_urlStringFull url "https://www.facebook.com/..."
Socialtwitter_urlStringFull url "https://twitter.com/..."
DevicesmaidStringMobile Advertisement ID (raw).
Devicesmaid_sha1StringHashed Mobile Advertisement ID.
Devicesmaid_sha2StringHashed Mobile Advertisement ID.
Devicesmaid_md5StringHashed Mobile Advertisement ID.
Phonephone_number_sha1StringHashed phone number.
Phonephone_number_sha2StringHashed phone number.
Phonephone_number_md5StringHashed phone number.
Emailpersonal_email_sha1StringHashed personal email.
Emailpersonal_email_sha2StringHashed personal email.
Emailpersonal_email_md5StringHashed personal email.
Emailwork_email_sha1StringHashed work email.
Emailwork_email_sha2StringHashed work email.
Emailwork_email_md5StringHashed work email.
Addressfull_addressStringFull-text search on the entire address.
Addresspre_addressString (Enum)Directional prefix, e.g., "N", "SW".
AddressstreetString"acorn"
Addressaddress_suffixStringStreet suffix, e.g., "AVE", "BLVD".
Addresspost_addressEnum (String)Directional postfix, e.g., "E", "NW".
AddresscityString"denver"
AddressstateString"California"
AddresszipString"4987587"
AddresslatitudeStringLatitude
AddresslongitudeStringLongitude
AddressradiusIntegerRadius -> area around lat - long (Min 100m, Max 10Km)
Householdhousehold_incomeEnum (String)"$150000_$174999"
Financialnet_worthEnum (String)"$5000_$9999"
Financialcredit_ratingEnum (String)"BETWEEN_600_649"
Employmentemployee_titleString"field auditor"
Employmentemployee_departmentString"Marketing"
Employmentemployee_levelEnum (String)"VP_LEVEL"
Employmentemployee_job_functionString"finance and administration"
Companycompany_idStringThe unique ID for the company.
Companycompany_nameString"community college of denver"
Companycompany_industryString"Education"
Companycompany_cityString"denver"
Companycompany_stateString"CO"
Companycompany_linkedinurlStringThe company's LinkedIn profile URL.
Companycompany_sic_codeString"8222"
Companycompany_naics_codeString"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:

CategoryFilter AttributeData TypeDescription / Example Value
Factoripeople_idStringThe unique ID for the individual.
Emailpersonal_email_addressStringRaw personal email: "[email protected]"
Phonephone_numberStringRaw phone number: "3387585869694"
Sociallinkedin_urlStringFull url "https://www.linkedin.com/..."
Socialfacebook_urlStringFull url "https://www.facebook.com/..."
Socialtwitter_urlStringFull url "https://twitter.com/..."
DevicesmaidStringMobile Advertisement ID (raw).
Devicesmaid_sha1StringHashed Mobile Advertisement ID.
Devicesmaid_sha2StringHashed Mobile Advertisement ID.
Devicesmaid_md5StringHashed Mobile Advertisement ID.
Phonephone_number_sha1StringHashed phone number.
Phonephone_number_sha2StringHashed phone number.
Phonephone_number_md5StringHashed phone number.
Emailpersonal_email_sha1StringHashed personal email.
Emailpersonal_email_sha2StringHashed personal email.
Emailpersonal_email_md5StringHashed personal email.
Emailwork_email_addressStringRaw work email address
Emailwork_email_sha1StringHashed work email.
Emailwork_email_sha2StringHashed work email.
Emailwork_email_md5StringHashed work email.

Option 2 :
Users must select at least one of the following:

CategoryFilter AttributeData TypeDescription / Example Value
Generalfirst_nameString"Mark"
Generallast_nameString"Tucker"

**AND ** Users must select at least one of the following:

CategoryFilter AttributeData TypeDescription / Example Value
Companycompany_nameString"community college of denver"
AddresscityString"denver"
AddressstreetString"acorn"
AddresszipString"4987587"
Companycompany_linkedinurlStringThe company's LinkedIn profile URL.
GeneralgenderEnum (String)"F" (Allowed: M, F)
GeneralageString“50”
Addressfull_addressStringFull-text search on the entire address.
Employmentemployee_titleString"field auditor"
Employmentemployee_job_functionString"finance and administration"
Employmentemployee_levelEnum (String)“VP_LEVEL”
AddresslatitudeStringLatitude
AddresslongitudeStringLongitude
AddressradiusIntegerRadius -> 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
}'