Resolution

GET
/v1/resolution

The resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the search endpoint, except it’s tuned to only return the best match so the client doesn’t need to do as much or any post-processing work to filter down results.

Query parameters

limitintegerOptional

A limit on the number of objects to be returned with a range between 1 and 10 inclusive. Defaults to 10.

offsetintegerOptional

Number of results to skip before returning response. Defaults to 0.

namestringOptional

Entity name

addressstringOptional

Entity address. For optimal matching results, it’s recommended to concatenate the full address string (street, city, state, postal code).

citystringOptional

Entity city that contains the provided city name.

statestringOptional

Entity state that contains the provided state name.

countryenumOptional

Entity country - must be ISO (3166) Trigram i.e., USA. See complete list here

identifierenumOptional

Entity identifier. Can be from either the Identifier Type or Weak Identifier Type enums.

date_of_birthstringOptional

Entity date of birth

contactstringOptional

Entity contact

typeenumOptional

Entity type. If multiple values are passed for any field, the endpoint will match entities with ANY of the values.

profileenumOptional

Specifies the search algorithm to use. corporate (default) is optimized for accurate entity attribute matching, ideal for business verification. suppliers is tailored for matching entities with trade data, suitable for supply chain use cases. search mimics /search/entity behavior, best for name-only matches.

Allowed values: corporatesupplierssearch
name_min_percentageintegerOptional

Adding this param enables an alternative matching logic. It will set a minimum percentage of tokens needed to match with user input to be considered a “hit”. Accepts integers from 0 to 100 inclusive.

name_min_tokensintegerOptional

Adding this param enables an alternative matching logic. It sets the minimum number of matching tokens the resolved hits need to have in common with the user input to be considered a “hit”. Accepts non-negative integers.

minimum_score_thresholdintegerOptional

Specifies the minimum score required to pass, which controls the strictness of the matching threshold. The default value is 77, and tuned for general use-case accuracy. Increase the value for stricter matching, reduce to loosen.

search_fallbackbooleanOptional

Enables a name search fallback when either the corporate or supplier profiles fails to find a match. When invoked, the fallback will make a call similar to /search/entity on name only. By default set to true.

Response

This endpoint returns an object.
fieldsobject
datalist of objects