Resolution

Resolution POST

POST
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.

Request

This endpoint expects an object.
name
list of stringsOptional
Entity name
identifier
list of unionsOptional

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

country
list of enumsOptional

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

address
list of stringsOptional
Entity address
date_of_birth
list of stringsOptional
Entity date of birth
contact
list of stringsOptional
Entity contact
type
list of enumsOptional

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

profile
enumOptional

Profile can be used to switch between search algorithms. The default profile corporate is optimized for accurate entity attribute matching and is ideal for business verification and matching entities with corporate data. The suppliers profile is optimized for matching entities with extensive trade data. Ideal for supply chain and trade-related use cases.

Allowed values: corporatesuppliers

Response

This endpoint returns an object
fields
object
data
list of objects
Built with