v7

latestOpenAPI 3.0.1raw.githubusercontent.com2024-10-04214.9 KB
Search

Starts a search.

post/v1/searches

Request body

querystring

Search query.

scope'person' | 'company'

The scope of the search. Valid values are 'person' or 'company'.

result_mode'exact' | 'best'

The mode of the search. Valid values are 'exact' or 'best'.

max_matchesnumber

The maximum number of results to return. optional for result_mode exact

Response

Search has been started. Poll based on the details in the response for the status and latest information.