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
The unique UUID identifier of the entity
namestring
The name of the entity
websitestring
The website URL of the entity
phone_numberstring
The phone number of the entity. This is a premium feature, please contact support to enable it.
tax_numberstring
The tax number of the entity. This is a premium feature, please contact support to enable it.
naics2017string
The 2017 NAICS code of the entity. This is a premium feature, please contact support to enable it.
mccslist of integers
A list of [Merchant Category Codes](https://en.wikipedia.org/wiki/Merchant_category_code)
parentobject
The parent entity
locationobject

Errors

400
Bad Request Error
422
Unprocessable Entity Error
423
Locked Error