Function: checkDomain()

checkDomain(domain: string, apiKey: string): Promise<{ classification: "unknown" | "malicious" | "suspicious" | "safe"; isScam: boolean; verifiedPhish: boolean; }>

Defined in: Phisherman.ts:20

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

Parameters

Parameter	Type	Default value	Description
domain	string	undefined	The domain to check.
apiKey	string	storedApiKey	optionally pass a Phiserman API key for making this request. This will default to storedApiKey, which can be configured through setApiKey.

Returns

Promise<{ classification: "unknown" | "malicious" | "suspicious" | "safe"; isScam: boolean; verifiedPhish: boolean; }>

Since

1.0.0