RErecordedfuture
Match

Match

Resolve human-readable entity names to Recorded Future entity IDs using fuzzy matching, with an optional type filter to narrow results to specific entity categories.

post/entity-match/match

Request

  • Base URL
    https://api.recordedfuture.com
  • URL
    https://api.recordedfuture.com/entity-match/match
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Request body

namestring required

This mandatory free text search field is used to match against entity names.

typestring[]

An array of types is optional. If in use, the Match operation will only try to match on entities that meet any of the "type" criteria. See the list of Available Entity Types.

limitinteger

This optional field is used to limit the max number of responses returned (maximum 100).

Example request

{
  "name": "WannaCry",
  "type": [
    "Malware"
  ]
}

Response

Successful request - Returns a list of items or an empty list if no items were found.

idstring required

Recorded Future entity ID (use with Lookup and other endpoints)

namestring required

Entity display name (may differ from search term)

typestring required

Entity type (e.g., CyberVulnerability, Malware, IpAddress, InternetDomainName)

Example response

[
  {
    "id": "TzghRB",
    "name": "WannaCry 1.0",
    "type": "Malware"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.