Tuesday, July 16, 2024

Data - Search
Action:
SEARCH
Method:
GET
URL: /api/v1/data/search/search
Description: Search for Dow Jones Data Entity records
Type Key DataType Notes
Headers api-key String Your Api-Key
Params EntityType Byte Entity Type [0=All, 1=Person, 2=Entity]
Params Gender Byte Gender [0=All, 1=Male, 2=Female]
Params LastName String Last Name
Params LastNameMatchPercentage Double Last Name Match Percentage [Values between 0.75 and 1.0]
Params FirstName String First Name
Params FirstNameMatchPercentage Double First Name Match Percentage [Values between 0.0 and 1.0]
Params MiddleName String Middle Name
Params MiddleNameMatchPercentage Double Middle Name Match Percentage [Values between 0.0 and 1.0]
Params ReverseSearch Boolean Perform an Additional Reverse Search
Params UnconstrainedSearch Boolean Perform Unconstrained Search
Params IsPEP Boolean Search for Politically Exposed People records [Person records only]
Params IsRCA Boolean Search for Relative or Close Associate records
Params IsWBL Boolean Search for Watch and Black Listed records
Params IsSAN Boolean Search for Sanctioned records
Params IsAVM Boolean Search for Adverse Media records [Entity records only]
Params IsOTH Boolean Search for Other Classification records
Params IsUNK Boolean Search for Unknown Classification records
Params FilterCountryCodes String Filter Country codes. [Numeric values seperated by semicolon.]
Params FilterYears String Filter Years. [Numeric YYYY values seperated by semicolon.]
Params ReturnDistinctValues Boolean Return Distinct Values. [Deduplicate multiple alias matches]
Params ReturnDetail Boolean Fetch Detail for each Search Result
Params ReturnDetailSuppressIdentifiersBoolean Suppress Identifiers in the returned Detail
Params DetailIncludeAddress Boolean Include Address data in the returned Detail
Params DetailIncludeAlias Boolean Include Alias data in the returned Detail
Params DetailIncludeBirthPlace Boolean Include Birth Place data in the returned Detail
Params DetailIncludeCountry Boolean Include Country data in the returned Detail
Params DetailIncludeDate Boolean Include Date data in the returned Detail
Params DetailIncludeDescription Boolean Include Description data in the returned Detail
Params DetailIncludeIdentity Boolean Include Identity data in the returned Detail
Params DetailIncludeImage Boolean Include Image data in the returned Detail
Params DetailIncludeNote Boolean Include Note data in the returned Detail
Params DetailIncludeOrigin Boolean Include Origin data in the returned Detail
Params DetailIncludeRelationshipDirectBoolean Include Relationship Direct data in the returned Detail
Params DetailIncludeRelationshipIndirectBoolean Include Relationship Indirect data in the returned Detail
Params DetailIncludeRole Boolean Include Role data in the returned Detail
Params DetailIncludeSanction Boolean Include Sanction data in the returned Detail
Params DetailIncludeVessel Boolean Include Vessel data in the returned Detail
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Search Results (For brevity the example below has ReturnDetail turned off. Check method "Data - Entity - GetDetail" for further information)
{
 "Count": 2,
 "Tokens": 997,
 "Identifiers": [
  {
   "EntityID": 98141
  },
  {
   "EntityID": 170352
  }
 ],
 "Results": [
  {
   "EntityID": 98141,
   "Serial": 0,
   "EntityTypeID": 1,
   "EntityTypeName": "Person",
   "GenderID": 1,
   "GenderName": "Male",
   "FirstName": "VLADIMIR",
   "MiddleName": "VLADIMIROVICH",
   "LastName": "PUTIN",
   "FullName": "VLADIMIR VLADIMIROVICH PUTIN",
   "FirstNameMatchPct": 100,
   "MiddleNameMatchPct": 0,
   "LastNameMatchPct": 100,
   "AverageMatchPct": 100,
   "Title": "",
   "Suffix": "",
   "IsReverse": false,
   "IsConstrained": true,
   "IsPEP": true,
   "IsRCA": false,
   "IsWBL": false,
   "IsSAN": false,
   "IsAVM": false,
   "IsOTH": false
   "IsUNK": false
  },
  {
   "EntityID": 170352,
   "Serial": 0,
   "EntityTypeID": 1,
   "EntityTypeName": "Person",
   "GenderID": 1,
   "GenderName": "Male",
   "FirstName": "VLADIMIR",
   "MiddleName": "SPIRIDONOVICH",
   "LastName": "PUTIN",
   "FullName": "VLADIMIR SPIRIDONOVICH PUTIN",
   "FirstNameMatchPct": 100,
   "MiddleNameMatchPct": 0,
   "LastNameMatchPct": 100,
   "AverageMatchPct": 100,
   "Title": "",
   "Suffix": "",
   "IsReverse": false,
   "IsConstrained": true,
   "IsPEP": false,
   "IsRCA": true,
   "IsWBL": false,
   "IsSAN": false,
   "IsAVM": false,
   "IsOTH": false
   "IsUNK": false
  }
 ]
}
Field Data Type
Count Int 32
Tokens Int 32
Identifiers Collection
 EntityID Int 32
Results Collection
 EntityID Int 32
 Serial Int 16
 EntityTypeID Byte
 EntityTypeName Text 150
 GenderID Byte
 GenderName Text 150
 FirstName Text 255
 MiddleName Text 255
 LastName Text 255
 FullName Text 255
 FirstNameMatchPct Decimal
 MiddleNameMatchPct Decimal
 LastNameMatchPct Decimal
 AverageMatchPct Decimal
 Title Text 255
 Suffix Text 255
 IsReverse Boolean
 IsConstrained Boolean
 IsPEP Boolean
 IsRCA Boolean
 IsWBL Boolean
 IsSAN Boolean
 IsAVM Boolean
 IsOTH Boolean
 IsUNK Boolean