Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Company

Search for Company entities based on a filter

Find companies by name, risk score, industry, or risk rules with paginated risk assessment results.

get/company/search

Query parameters

freetextstring

Freetext

fieldsstring

The enrichment fields requested for the entities returned. Several fields can be given as a comma separated string.

See https://docs.recordedfuture.com/reference/enrichment-field-attributes for a list of values.

{"stackTrail":"components:parameters:MetadataParameter:schema","oasType":"schema","type":"unknown"}

Annotates the response with additional metadata explaining the response data elements.

limitinteger

Maximum number of records returned,

frominteger

Offsets the pagination of the request. Note that there is a limit of returning only the top 10000 results from a search, meaning if limit plus from exceeds 10000, this will result in an Bad Request message.

riskScorestring

Filters entities based on risk score, e.g. on the form [20, 80] (20 <= risk score <= 80), [20,) (20 <= risk score), or [,90) (risk score < 90). '[' and ']' are inclusive while '(' and ')' are exclusive.

firstSeenstring

Filters entities based on the download of the first reference which is taken into account during risk scoring of the entity. All Elasticsearch compatible date formats are valid.

lastSeenstring

Filters entities based on the download of the latest reference which is taken into account during risk scoring of the entity. All Elasticsearch compatible date formats are valid.

liststring

Filters entities based on presence in a single list. Requires the list ID, which can be found using the List API

parentstring

Filters for companies based on parent company. The expected value is a Company ID.

industrystring

Filters for companies based on industry. The expected value is a Industry ID.

domicilestring

Filters for companies based on domicile. The expected value is a valid Entity ID for a country, e.g. "B_FAG" for the United States. The Entity Match API is available to lookup other country Entity IDs.

riskRule'analystNote' | 'certExpired' | 'certSelfSigned' | 'cyberSignalCritical' | 'cyberSignalHigh' | 'cyberSignalMedium' | 'dkimImproper' | 'dkimweak' | 'dmarcAbsent' | 'dnsSandwichTargetedDomain' | 'exploitableInfrastructure' | 'exploitedProduct' | 'highCreds' | 'highPasswordCreds' | 'highTierHighVolume' | 'highTierModerateVolume' | 'hsts' | 'infrastructureAbuse' | 'infrastructureInfection' | 'likelyViolation' | 'marketHighVolume' | 'marketModerateVolume' | 'moderateCreds' | 'moderatePasswordCreds' | 'openPort' | 'possibleMalware' | 'possibleViolation' | 'punyCodeTargetedDomain' | 'ransomwareExtortion' | 'recentAnalystNote' | 'recentCncCommunication' | 'recentDnsSandwichTargetedDomain' | 'recentExploitableInfrastructure' | 'recentHighCreds' | 'recentHighPasswordCreds' | 'recentHighTierHighVolume' | 'recentHighTierModerateVolume' | 'recentInfrastructureAbuse' | 'recentInfrastructureInfection' | 'recentMarketHighVolume' | 'recentMarketModerateVolume' | 'recentModerateCreds' | 'recentModeratePasswordCreds' | 'recentPossibleMalware' | 'recentPunyCodeTargetedDomain' | 'recentRansomwareExtortion' | 'recentReportedCyberAttack' | 'recentSecurityBreach' | 'recentSingleSourceCreds' | 'recentSingleSourcePasswordCreds' | 'recentSuspectedCncCommunication' | 'recentSuspectedDdosAttack' | 'recentTypoTargetedDomain' | 'recentValidatedCyberAttack' | 'reportedCyberAttack' | 'securityBreach' | 'singleSourceCreds' | 'singleSourcePasswordCreds' | 'spfMultiple' | 'spfOverlyPermissive' | 'spfUnrestricted' | 'sslTlsVuln' | 'sslWeak' | 'tlsWeak' | 'topicalVulnerability' | 'typoTargetedDomain' | 'unsupportedProduct' | 'validatedCyberAttack' | 'vulnerableProduct'

Filters for companies based on a single risk rule.

orderBy'created' | 'modified' | 'sixtydayshits' | 'sevendayhits' | 'criticality' | 'riskscore' | 'totalhits' | 'firstseen' | 'lastseen' | 'rules'

Sorts the search according to the chosen parameter. Results are sorted before pagination.

direction'asc' | 'desc'

The direction of the sorting by the orderBy parameter, ascending or descending.

commentstring

Response

Result of operation