POST
/
api
/
v1
/
scan
/
namesearch

Body parameters

company_input_data
ScanFirmInput
entity_type
integer

Mandatory. 1 means Individual, 2 means Firm

exact_match
boolean
keep_results_under_threshold
boolean

Returns results under threashold defined by the post-filtering alias (or 50% by default).

page_size
integer
page_token
string

Optional. Set to empty string or don’t set for first page.

person_input_data
ScanIndividualInput
post_filtering_alias
string

null to not use any post-filtering, empty string to use the default post-filtering settings, or use an alias.

query
string

Deprecated. Use ScanIndividualInput or ScanFirmInput instead.

Response body

next_page_token
string
results
ScanOutput[]
total
integer