API ReferenceEntityGA

Get Entity

To retrieve a L1 Due Dilligence PDF Report. Include ‘Accept: application/pdf’ in request headers.
Retrieve an entity profile from the database based on the entity ID. This endpoint returns the full profile, entity_summary returns the same payload minus relationships.

Path parameters

idstringRequired
Unique identifier of the entity

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

attributes.additional_information.nextstringOptional

The pagination token for the next page of attribute additional_information.

attributes.additional_information.prevstringOptional

The pagination token for the previous page of attribute additional_information.

attributes.additional_information.limitintegerOptional

Limit total values returned for attribute additional_information. Defaults to 100.

attributes.address.nextstringOptional

The pagination token for the next page of attribute address.

attributes.address.prevstringOptional

The pagination token for the previous page of attribute address.

attributes.address.limitintegerOptional

Limit total values returned for attribute address. Defaults to 100.

attributes.business_purpose.nextstringOptional

The pagination token for the next page of attribute business_purpose.

attributes.business_purpose.prevstringOptional

The pagination token for the previous page of attribute business_purpose.

attributes.business_purpose.limitintegerOptional

Limit total values returned for attribute business_purpose. Defaults to 100.

attributes.company_type.nextstringOptional

The pagination token for the next page of attribute company_type.

attributes.company_type.prevstringOptional

The pagination token for the previous page of attribute company_type.

attributes.company_type.limitintegerOptional

Limit total values returned for attribute company_type. Defaults to 100.

attributes.country.nextstringOptional

The pagination token for the next page of attribute country.

attributes.country.prevstringOptional

The pagination token for the previous page of attribute country.

attributes.country.limitintegerOptional

Limit total values returned for attribute country. Defaults to 100.

attributes.identifier.nextstringOptional

The pagination token for the next page of attribute identifier.

attributes.identifier.prevstringOptional

The pagination token for the previous page of attribute identifier.

attributes.identifier.limitintegerOptional

Limit total values returned for attribute identifier. Defaults to 100.

attributes.name.nextstringOptional

The pagination token for the next page of attribute name.

attributes.name.prevstringOptional

The pagination token for the previous page of attribute name.

attributes.name.limitintegerOptional

Limit total values returned for attribute name. Defaults to 100.

attributes.status.nextstringOptional

The pagination token for the next page of attribute status.

attributes.status.prevstringOptional

The pagination token for the previous page of attribute status.

attributes.status.limitintegerOptional

Limit total values returned for attribute status. Defaults to 100.

relationships.nextstringOptional

The pagination token for the next page of relationship results

relationships.prevstringOptional

The pagination token for the previous page of relationship results

relationships.limitintegerOptional

Limit total relationship values. Defaults to 50.

relationships.typeenumOptional

Filter relationships to relationship type, e.g. director_of or has_shareholder

relationships.sortstringOptional

Sorts relationships by As Of date or Shareholder percentage, e.g. date or -shares

relationships.startDatedateOptional

Filters relationships to after a date

relationships.endDatedateOptional

Filters relationships to before a date

relationships.minSharesintegerOptional

Filters relationships to greater than or equal to a Shareholder percentage

relationships.countryenumOptional

Filters relationships to a list of countries

relationships.arrivalCountryenumOptional

Filters shipment relationships to a list of arrival countries

relationships.arrivalStatestringOptional

Filters shipment relationships to an arrival state

relationships.arrivalCitystringOptional

Filters shipment relationships to an arrival city

relationships.departureCountryenumOptional

Filters shipment relationships to a list of departure countries

relationships.departureStatestringOptional

Filters shipment relationships to a departure state

relationships.departureCitystringOptional

Filters shipment relationships to a departure city

relationships.partnerNamestringOptional

Filters shipment relationships to a trade partner name

relationships.partnerRiskenumOptional

Filters shipment relationships to a trade partner risk tag

relationships.hsCodestringOptional

Filters shipment relationships to an HS code

possibly_same_as.nextstringOptional

The pagination token for the next page of possibly same entities.

possibly_same_as.prevstringOptional

The pagination token for the previous page of possibly same entities.

possibly_same_as.limitintegerOptional

Limit total possibly same as entities. Defaults to 100.

referenced_by.nextstringOptional

The pagination token for the next page of the entity’s referencing records

referenced_by.prevstringOptional

The pagination token for the previous page of the entity’s referencing records

referenced_by.limitintegerOptional

Limit totals values returned for entity’s referencing records. Defaults to 100.

Response

This endpoint returns an object.
addresseslist of strings
List of physical addresses associated with the entity. See more [here](/sayari-library/ontology/attributes#address)
attribute_countmap from enums to integers
Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)
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](/sayari-library/ontology/enumerated-types#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](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), 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](/sayari-library/ontology/relationships).
riskmap from enums to objects
[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity.
sanctionedboolean
True if the entity has the ["Sanctioned" risk factor](/sayari-library/ontology/risk-factors#sanctioned), 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](/sayari-library/ontology/entities).
user_attribute_countmap from enums to integers
Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)
user_record_countinteger
user_relationship_countmap from enums to integers
Count of related entities for a given [relationship type](/sayari-library/ontology/relationships).
attribute_countsmap from enums to integersOptional
Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)
attributesobjectOptional
Detailed information about the entity's [attributes](/sayari-library/ontology/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](/sayari-library/ontology/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](/sayari-library/ontology/attributes)

Errors