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.

Headers

X-Api-KeystringRequired
X-Application-IdstringRequired

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

idstringOptional

The unique UUID identifier of the entity

namestringOptional

The name of the entity

websitestringOptional

The website URL of the entity

mccslist of integersOptional

A list of Merchant Category Codes

Errors