Skip to main content

Function: checkDomain()

checkDomain(domain: string, apiKey: string): Promise<object>

Checks if a link is detected as a scam or phishing link by phisherman.

Parameters

ParameterTypeDefault valueDescription
domainstringundefinedThe domain to check.
apiKeystringstoredApiKeyoptionally pass a Phiserman API key for making this request. This will default to storedApiKey, which can be configured through setApiKey.

Returns

Promise<object>

classification

classification: "unknown" | "malicious" | "suspicious" | "safe"

isScam

isScam: boolean

verifiedPhish

verifiedPhish: boolean

Since

1.0.0

Source

lib/Phisherman.ts:20