Input Parameters

API Fields

The following are the list of attributes that can used to filter the Persons data

• persons_attributes in Factori APIs help you provide filters based on which you will be receiving data of individuals
• output_fields in Factori APIs help you receive only those attributes that are useful to you instead of receiving all attributes in the response. For example, "output_fields": ["first_name", "company_name"] means to say that if a record matches a given criteria return only the first name and the company name
• 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": ["phone_numbers", "emails"] 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 any Persons based on some criteria. In the below example the API response will exclude any Person with a "person_id": "123"

"must_not_contain": {
	"person_id": ["123"]
}

• maximum_record_limit in Factori APIs help you in specifying the number of credits you would like to utilise in a given request. In case the maximum_record_limit is not utilised then you will be returned 100 records by default.
• page_no in Factori APIs will help you navigate the response using pagination
• All emails in our end are lowercase and empty spaces are trimmed before hashing.
• All phone numbers in our end 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 in our end are lowercase and empty spaces are trimmed before hashing.
• Factori APIs accept full_address in the standard format specified by the USPS.
• Any address_suffix mentioned 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 "M" for male and "F" for 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

• household_income field in Factori APIs accept the following ranges

Here is the list of state abbreviations and their expansions:

Here is the table showing different credit rating range

Here is the table showing how employee level are represented:

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

Types

1. Enrich

The Enrich API is built to help you enrich your existing data with attributes that provide you with a complete graph of your customers. The general practice is to use the Search API to filter records and then use the Enrich API to enrich only those relevant records

The Enrich API response gives you access to all available attributes mentioned on the page above.

2. Verify

In an increasingly digital world, the incidence of digital fraud is on the rise. Malicious individuals are continuously seeking fresh methods to engage in fraudulent activities, including the creation of synthetic identities, identity theft, and taking over user accounts. Companies are faced with the challenge of maintaining a seamless customer onboarding experience while simultaneously working to reduce fraud and safeguard their platforms.

The API can accept a wide variety of inputs to verify an individual, such as:

1. Phone
2. Email
3. MAID

Example

1. An example of a Enrich Request

curl --location 'https://api.factori.ai/person/v1.2/enrich' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Token>' \
--data '{
    "persons_attributes": {
        "city": "los angeles",
        "state": "ca",
        "net_worth": "$50000_$99999"
    },
    "must_contain": [
        "first_name",
        "last_name",
        "gender"
    ],
    "must_not_contain": {
    	"person_id": ["123"]
    },
    "output_fields": [
        "first_name",
        "last_name",
        "gender",
        "address"
    ],
    "maximum_record_limit": 1000,
    "page_no": 2
}'

Fields to search Person Data