API Documentation

Entity Types and ID Prefixes

Recorded Future entity ID prefixes for building IDs directly, plus every entity type value accepted by the Entity Match type filter. Type values are case sensitive.

ID prefixes

Many entity types have a predictable Recorded Future ID: a type prefix followed by the value itself. For these types you can build the ID directly and pass it to any endpoint that accepts an entity ID, such as Entity: Lookup, Lists: Add Entity, or the type-specific lookup endpoints. No Entity Match call is needed.

Entity typePrefixExample ID
ASNumberasn:asn:AS16276
AWSAccessKeyext:aws:ext:aws:AKIAIOSFODNN7EXAMPLE
BankIdentificationNumberbin:bin:414720
BitcoinAddressbitcoin:bitcoin:13d650aaf08f8f1d27680abb651f7093bd7c5731
EmailAddressemail:email:[email protected]
Hashhash:hash:049ed15ef970bd12ce662cffa59f7d0e0b360d47fac556ac3d36f2788a2bc5a4
InternetDomainNameidn:idn:recordedfuture.com
IpAddressip:ip:8.8.8.8
MitreAttackIdentifiermitre:mitre:T1082
NumericIdentifiernum:num:439088618393
PaymentCardNumbercc:cc:4111111111111111
PhoneNumbertel:tel:1118038632
ProductVersionv:v:1.6.11
URLurl:url:http://uploading.com/files/7dcd1222/Souvenirs
UUIDuuid:uuid:beffbfda-5d17-44b1-b6d9-f3369027f51f
WebMoneyIDwmid:wmid:226970548705

All other types, including Malware, CyberVulnerability, Company, Organization, Person, and Product, use opaque IDs (for example, AsyncRAT is Yzaz0L). Resolve these with Entity: Match. CVE strings such as CVE-2021-44228 are not valid entity IDs.

Entity types

These are the values accepted by the type filter on Entity: Match. The list changes as Recorded Future adds new entity types.

Case sensitivity. Type values and request field names (name, type, limit) are case sensitive. A wrong-case field name returns a 400 error that names the unrecognized parameter. A wrong-case type value, such as malware instead of Malware, returns an empty array with no error.

CategoryEntity Types
Cyber Threat & SecurityAttackVector CyberExploitTargetCategory CyberSecurityCategory CyberThreatActorCategory CyberVulnerability DetectionRule IncidentImpactCategory Malware MalwareCategory MalwareMutex MalwareSignature MitreAttackIdentifier RiskContext RiskRule SnortDetectionRule YaraDetectionRule
Network & InfrastructureASNumber InternetDomainName IpAddress IRCNetwork NetworkPort NetworkProtocol Port URL
Files & HashesFileContent FileName FileNameExtension FileType Hash HashAlgorithm
Identity & CredentialsAWSAccessKey BankIdentificationNumber BitcoinAddress BusinessIdentifierCode DEANumber EmailAddress FaxNumber PaymentCardNumber PhoneNumber SocialSecurityNumber Username WebMoneyID
GeographicAirport City Continent Country Embassy GeoBoundingBox GeoEntity MilitaryBase Nationality NaturalFeature Neighborhood ProvinceOrState Region
Organizations & PeopleCompany Facility Industry Organization OrgEntity Person Position Sector
Technology & SoftwareCodeIdentifier OperatingSystem Product ProductIdentifier ProductModule ProductModuleAddon ProductVersion ProgrammingLanguage Technology TechnologyArea WinRegKey
Financial & EconomicCommodity Currency CurrencyPair EconomicIndicator MarketIndex MICR
Media & EntertainmentEntertainmentAwardEvent Movie MusicAlbum MusicGroup PublishedMedium RadioProgram RadioStation SportsEvent SportsGame SportsLeague TVShow TVStation
Tracking & IdentifiersExternalIdentifier Identifier NumericIdentifier UPSTrackingNumber USPSTrackingNumber UUID
User & PlatformIntegrationApplication IntegrationUser User UserEnterprise UserEntity UserGroup UserLabel UserModuleGroup UserModuleRoleGroup UserOrganization UserRole
RF Analysis & MetadataAnalystNote Case Category ContentType Dataset Document Entity EntityAlias EntityList EntityRange EntityRelation Feature Keyword Language LinkReport Logotype MetaAttribute MetaType Operation ReportEntity ReportingEntity Source SourceMediaType Task Thread Topic UseCaseConfiguration UseCaseReport
OtherAircraft Anniversary Emoji Hashtag Holiday Image IndustryTerm MedicalCondition MedicalTreatment MilitaryExercise Religion Vessel