Entity

Entity Summary

GET
The Entity Summary endpoint returns a smaller entity payload

Path parameters

idstringRequired
Unique identifier of the entity

Response

This endpoint returns an object
addresses
list of strings

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

attribute_count
map from enums to integers

Count of attributes for a given attribute type

closed
boolean
True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation.
countries
list of enums

Entity country

degree
integer
Number of outgoing relationships
entity_url
string
Convenience URL to the entity in the API.
id
string
Unique identifier of the entity
identifiers
list of objects
Identifiers associated with the entity.
label
string
Display name of the entity
pep
boolean

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

psa_count
integer
Number of entities that are Possibly the Same As (PSA) the entity.
related_entities_count
integer
relationship_count
map from enums to integers

Count of related entities for a given relationship type.

risk
map from enums to objects

Risk factors associated with the entity.

sanctioned
boolean

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

source_count
map from strings to objects
Number of records associated with the entity, grouped by source.
trade_count
map from strings to integers
type
enum

The entity type.

user_attribute_count
map from enums to integers

Count of user-created attributes for a given attribute type

user_record_count
integer
user_related_entities_count
integer
user_relationship_count
map from enums to integers

Count of related entities for a given relationship type.

attributes
objectOptional

Detailed information about the entity’s attributes.

company_type
stringOptional
A type of legal entity in a given jurisdiction (e.g. 'LLC,' 'Sociedad Anonima,' 'Private Company Limited by Shares')
date_of_birth
stringOptional

Birth date of a person. See more here

hs_code
stringOptional
Harmonized Tariff Schedule Code associated with the entity/shipment
latest_status
objectOptional
The most recent status of an entity and when that status was observed.
possibly_same_as
objectOptional
List of entities that are Possibly the Same As (PSA) the entity.
psa_id
stringOptional
reference_id
stringOptional
referenced_by
objectOptional
List of records that reference the entity.
registration_date
stringOptional
Type (registered/incorporated/active) and date of the earliest significant activity associated with the entity. Will appear as 'Registered YYYY-MM-DD'
relationships
objectOptional

Detailed information about the entity’s relationships.

shipment_arrival
stringOptional
Arrival date of a shipment.
shipment_departure
stringOptional
Departure date of a shipment.
translated_label
stringOptional
Label in English if available. Translation performed by Sayari.
Built with