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.
namestring or nullOptional
The name of the entity to resolve
websitestring or nullOptional
The website of the entity to resolve
locationstring or nullOptional
An unstructured location string of the entity to resolve

Response

Entity
idstring or nullOptional
The unique UUID identifier of the entity
namestring or nullOptional
The name of the entity
websitestring or nullOptional
The website URL of the entity
phone_numberstring or nullOptional
The phone number of the entity. This is a premium feature, please contact support to enable it.
tax_numberstring or nullOptional
The tax number of the entity. This is a premium feature, please contact support to enable it.
naics2017string or nullOptional
The 2017 NAICS code of the entity. This is a premium feature, please contact support to enable it.
mccslist of integersOptional
parentobject or nullOptional
The parent entity
locationobject or nullOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error
423
Locked Error