Skip to main content
GET
Retrieve an Entity

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Response

Entity resource response

@context
string
default:/contexts/Entity
@id
string<iri-reference>

Entity IRI reference

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:Link

JSON-LD resource type; Entity resources currently use the legacy Link JSON-LD type for backwards compatibility

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

type
enum<string>

Type of entity

Available options:
company,
person
Example:

"company"

taxpayer
object
credential
object
tags
object[]
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"