API ReferenceEntities

Resolves an entity

Resolves a query into an entity by querying our entity resolution system. The parameters name and website are mutually exclusive. Calls to this endpoint using the name parameter are billed the same way transactions are.

Authentication

X-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringOptional
The name of the entity to resolve
websitestringOptional
The website of the entity to resolve
locationstringOptional
An unstructured location string of the entity to resolve

Response

Entity
idstring or null
The unique UUID identifier of the entity
namestring or null
The name of the entity
websitestring or null
The website URL of the entity
mccslist of integers or null
A list of [Merchant Category Codes](https://en.wikipedia.org/wiki/Merchant_category_code)
phone_numberstring or null
The phone number of the entity. This is a premium feature, please contact support to enable it.
tax_numberstring or null
The tax number of the entity. This is a premium feature, please contact support to enable it.
naics2017string or null
The 2017 NAICS code of the entity. This is a premium feature, please contact support to enable it.
locationobject or null

Errors