The Entities Pro service allows users to retrieve company hierarchies and summary statistics. This service is available to Premium Plus subscribers through the CLAIMS Direct platform as a separate data subscription. It is the foundation of our IP Profiles. If you are interested in accessing this service, please contact your sales representative.

Installing Additional Streams

This service is currently BETA. Request parameters and response formats may change.

Response Members

The following fields may be returned in the Entities Pro service:

Member	Description	Notes

Member	Description	Notes
ifi_number	Integer identifier linking the entity to publications	Linking to publications is only available with an on-site installation.
status	Entity status. Values include: R=Reviewed V=Validated	On-site installations may also contain other entities with status P or B, which should be ignored.
category_name	Category of entity. Values include: Cooperative Delisted Education Facility Government Healthcare Joint Venture Nonprofit Private Public Research Trust Undefined
created_load_id	Load-id corresponding to entity creation
modified_load_id	Load-id of last update to entity
standard_name	IFI standardized name of the entity	This is the name found in the CLAIMS Direct Snapshots.
parent_entity_id	Parent entity identifier	If entity_type=O, this id, uo_entity_id, and entity_id will be identical.
entity_type	Type of entity. Values include: F=Former Name M=Merged N=Standard Name O=Owner S=Subsidiary
country	Code of the entity's country of incorporation or registration
uo_entity_id	Ultimate Owner (UO) entity identifier
standard_name_id	IFI Standard Name identifier
entity_address	Address information for the entity
last_modified	Date entity hierarchy was last reviewed
entity_name	Name of entity
entity_id	Entity identifier
ticker	Ticker symbol and exchange the symbol is traded on
ultimate_owner	Ultimate Owner (UO) name
subsidiary_total	Number of UO subsidiaries and related entities holding IP assets
publications_total	Total number of UO patent-related publications
publications_application_level	Total number of UO patent applications
publications_grant_level	Total number of UO granted patents
publications_unknown_level	Total number of UO patents for which the status is unknown
publications_status_active	Total number of UO granted patents that are still in force, i.e., active
publications_status_pending	Total number of UO patent applications that are pending
publications_status_lapsed	Total number of UO granted patents that have expired, i.e., no longer in force
publications_status_unknown	Total number of UO patent-related publications for which the status is unknown
citations_forward	Total number of unique forward citations, i.e., other patent publications citing UO family members
citations_backward	Total number of unique backward citations, i.e., UO family members citing other patent publications
family_total	Total number of UO patent families
family_status_pending	Total number of UO patent families that only contain patent applications that have not granted, i.e., that are still pending
family_status_active	Total number of UO patent families that contain at least one granted patent that is still in force
family_status_lapsed	Total number of UO patent families for which all granted patents have expired

/entities/ultimate

This endpoint returns the ultimate owner of a given name parameter.

Method	GET

Method	GET
Path	/entities/ultimate
Parameter		Values	Description
	@name	Google LLC	Any validated or reviewed IFI entity name

Example

 wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/entities/ultimate?name=Google LLC'

Response

{
  "ultimate" : {
    "ifi_number" : 135040,
    "status" : "V",
    "ticker" : [
      {
        "symbol" : "GOOGL",
        "exchange" : "XNAS"
      },
      {
        "symbol" : "GOOG",
        "exchange" : "XNAS"
      }
    ],
    "category_name" : "Public",
    "modified_load_id" : 734763,
    "standard_name" : "Alphabet Inc",
    "parent_entity_id" : 3898,
    "created_load_id" : 614351,
    "entity_type" : "O",
    "country" : "US",
    "uo_entity_id" : 3898,
    "standard_name_id" : 135040,
    "entity_address" : "1600 Amphitheatre Parkway, Mountain View, CA, 94043, US",
    "last_modified" : "2020-11-16",
    "entity_name" : "Alphabet Inc",
    "entity_id" : 3898
    },
  "time" : "0.269",
  "status" : "success"
}

/entities/subsidiaries

This endpoint returns all subsidiaries of a given ultimate owner.

Method	GET

Method	GET
Path	/entities/subsidiaries
Parameter		Values	Description
	@name	Dow Inc	Any validated or reviewed ultimate owner

Example

 wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/entities/subsidiaries?name=Alphabet Inc'

Response

{
  "time" : "0.142",
  "status" : "success",
  "subsidiaries" : [
    {
      "country" : "US",
      "entity_id" : 424078,
      "entity_type" : "F",
      "parent_entity_id" : 69201,
      "entity_name" : "Admob Google Inc"
    },
    {
      "country" : "US",
      "entity_id" : 69201,
      "entity_type" : "S",
      "parent_entity_id" : 69315,
      "entity_name" : "Admob Inc"
    },
    {
      "country" : "US",
      "entity_id" : 69202,
      "entity_type" : "S",
      "parent_entity_id" : 69315,
      "entity_name" : "Adometry Inc"
    }
; etc.
  ]
}

/entities/info

This endpoint returns all information for a given entity name.

Method	GET

Method	GET
Path	/entities/info
Parameter		Values	Description
	@name	String, e.g., Waze Inc	Any validated or reviewed IFI entity name
	@ucid	EP-0700000-B1	Any IFI unique publication character identifier Not all publications will map up to a valid IFI entity.

Example

 wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/entities/info?name=Waze Inc'

Response

{
  "info" : {
    "ifi_number" : 135040,
    "status" : "V",
    "ticker" : [
      {
        "symbol" : "GOOGL",
        "exchange" : "XNAS"
      },
      {
        "symbol" : "GOOG",
        "exchange" : "XNAS"
      }
    ],
    "category_name" : "Public",
    "modified_load_id" : 734763,
    "standard_name" : "Alphabet Inc",
    "parent_entity_id" : 3898,
    "created_load_id" : 614351,
    "entity_type" : "O",
    "country" : "US",
    "uo_entity_id" : 3898,
    "standard_name_id" : 135040,
    "entity_address" : "1600 Amphitheatre Parkway, Mountain View, CA, 94043, US",
    "last_modified" : "2020-11-16",
    "entity_name" : "Alphabet Inc",
    "entity_id" : 3898
  },
  "time" : "0.140",
  "status" : "success"
}

/entities/portfolio

This endpoint returns complete statistics for an entire entity hierarchy.

Method	GET

Method	GET
Path	/entities/portfolio
Parameter		Values	Description
	@name	Alphabet Inc	Any validated or reviewed IFI entity name
	@ucid	EP-0700000-B1	Any IFI unique publication character identifier Not all IFI publications will map up to a valid IFI entity.

Example

wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'https://cdws21.ificlaims.com/entities/portfolio?name=Waze Inc'

Response (abbreviated)

{
   "portfolio" : {
      "name" : "Waze Inc",
      "ultimate_owner" : "Alphabet Inc",
      "subsidiary_total" : 181,

      "publications_total" : 170698,
      "publications_application_level" : 73063,
      "publications_grant_level" : 61479,
      "publications_unknown_level" : 36156,

      "publications_status_active" : 88344,
      "publications_status_pending" : 15710,
      "publications_status_lapsed" : 30490,
      "publications_status_unknown" : 36154,

      "citations_forward" : 825531,
      "citations_backward" : 391478,

      "family_total" : 35470,
      "family_status_pending" : 2220,
      "family_status_active" : 22810,
      "family_status_lapsed" : 10440,
   },
   "time" : "0.039",
   "status" : "success"
}