API ReferenceEntity

Entity Summary

The Entity Summary endpoint returns a similar payload, minus relationships.

Path parameters

idstringRequired
Unique identifier of the entity

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Response

This endpoint returns an object.
addresseslist of strings

List of physical addresses associated with the entity. See more here

attribute_countmap from enums to integers

Count of attributes for a given attribute type

closedboolean
True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation.
countrieslist of enums

Entity country

degreeinteger
Number of outgoing relationships
entity_urlstring
Convenience URL to the entity in the API.
idstring
Unique identifier of the entity
identifierslist of objects
labelstring
Display name of the entity
pepboolean

True if the entity has the “Politically Exposed Person (PEP)” risk factor, otherwise false.

psa_countinteger

Number of entities that are Possibly the Same As (PSA) the entity.

related_entities_countinteger
relationship_countmap from enums to integers

Count of related entities for a given relationship type.

riskmap from enums to objects

Risk factors associated with the entity.

sanctionedboolean

True if the entity has the “Sanctioned” risk factor, otherwise false.

source_countmap from strings to objects
Number of records associated with the entity, grouped by source.
trade_countmap from strings to integers
typeenum

The entity type.

user_attribute_countmap from enums to integers

Count of user-created attributes for a given attribute type

user_record_countinteger
user_relationship_countmap from enums to integers

Count of related entities for a given relationship type.

attribute_countsmap from enums to integersOptional

Count of attributes for a given attribute type

attributesobjectOptional

Detailed information about the entity’s attributes.

company_typestringOptional

A type of legal entity in a given jurisdiction (e.g. ‘LLC,’ ‘Sociedad Anonima,’ ‘Private Company Limited by Shares’)

date_of_birthstringOptional

Birth date of a person. See more here

hs_codestringOptional

Harmonized Tariff Schedule Code associated with the entity/shipment

latest_statusobjectOptional
The most recent status of an entity and when that status was observed.
possibly_same_asobjectOptional

List of entities that are Possibly the Same As (PSA) the entity.

psa_idstringOptional
reference_idstringOptional
referenced_byobjectOptional
List of records that reference the entity.
registration_datestringOptional

Type (registered/incorporated/active) and date of the earliest significant activity associated with the entity. Will appear as ‘Registered YYYY-MM-DD’

relationshipsobjectOptional

Detailed information about the entity’s relationships.

shipment_arrivalstringOptional
Arrival date of a shipment.
shipment_departurestringOptional
Departure date of a shipment.
translated_labelstringOptional
Label in English if available. Translation performed by Sayari.
user_attribute_countsmap from enums to integersOptional

Count of user-created attributes for a given attribute type

Errors