Input Parameters - Cleaner APIs

Detailed information on the input parameters for the Cleaner APIs

Company Cleaner API Parameters (/company/clean)

While all parameters are optional, we require a non-ambiguous match. This means that you must input a name OR website OR profile.

name

Parameter NameRequiredDescriptionExample
nameNoThe name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth.People data Labs

profile

Parameter NameRequiredDescriptionExample
profile NoThe social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth.linkedin.com/company/google

website

Parameter NameRequiredDescriptionExample
website NoThe website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth.www.peopledatalabs.com

pretty

Parameter NameRequiredDescriptionExample
pretty NoWhether the output should have human-readable indentation.True

api_key

Parameter NameRequiredDescriptionExample
api_keyNo*Your secret API key.

While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page.


Location Cleaner API (/location/clean)

location

Parameter NameRequiredDescriptionExample
location YesThe name of the location that you want to identify. We accept unformatted locations with arbitrary capitalizations, leading and trailing whitespaces and so forth.San Francisco

pretty

Parameter NameRequiredDescriptionExample
pretty NoWhether the output should have human-readable indentation.True

api_key

Parameter NameRequiredDescriptionExample
api_keyNo*Your secret API key.

While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page.


School Cleaner API (/school/clean)

While all parameters are optional, we require a non-ambiguous match. This means that you must input a name OR website OR profile.

name

Parameter NameRequiredDescriptionExample
nameNoThe name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth.People data Labs

profile

Parameter NameRequiredDescriptionExample
profile NoThe social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth.linkedin.com/company/google

website

Parameter NameRequiredDescriptionExample
website NoThe website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth.www.peopledatalabs.com

pretty

Parameter NameRequiredDescriptionExample
pretty NoWhether the output should have human-readable indentation.True

api_key

Parameter NameRequiredDescriptionExample
api_keyNo*Your secret API key.

While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page.