🧩 Plugins
Get additional information using plugins.
About Plugins
What are plugins for?
We believe that one of the primary ways to enhance our product by increasing the amount of information and speed of response is by using a plugin system, where you will select plugins in addition to the default information that our API offers.
For this you can optionally add the different plugins that we offer to get more information and avoid receiving all the information in each request if you do not need it; in this way we increase the speed of the response.
Plugins
Authorization
String
required
Note that the use of plugins increases credits consumption.
| Plugin | Response type | Compatibility | Description |
|---|---|---|---|
blocklist | Boolean | All data are supported | Check for a match in your blocklist |
compromiseDetector | Boolean | Email, Domain | Verify if a data has been breached/hacked |
gravatar | String | Null | Verify if a user has a profile picture on Gravatar | |
mxRecords | MXRecords | URL, Email, Domain | Checks if a data is NSFW content |
nsfw | Boolean | URL, Email, Domain | Checks if a data is NSFW content |
reachable | ReachableResult | Ensure that an email is reachable | |
reputation | Reputation | Email, Domain | Verify the size of a company |
riskScore | Number (0-100) | All data are supported | Verify the risk score of a data |
socialFootprint | SocialFootprint | Discover linked accounts across platforms | |
spam | Boolean | URL, Domain, Email, Phone, IP | Detect if data is flagged as spam |
torNetwork | Boolean | URL, Email, Domain, IP | Verify if a domain or IP belongs to Tor network |
typosquatting | Number (0-10) | URL, Email, Domain | Verify if a domain is typosquatting |
urlShortener | Boolean | URL, Email, Domain | Verify if a domain is an url shortener |
Response
The more plugins you add, the longer the response time will be.
{
url: {
valid: true,
fraud: false,
freeSubdomain: false,
customTLD: false,
url: "https://test.com/test",
domain: "test.com",
plugins: {
blocklist: false,.
compromiseDetector: false,
mxRecords: [],
nsfw: false,
reputation: "low", // BETA.
riskScore: 0,
spam: false,
torNetwork: false,
typosquatting: 0, // BETA.
urlShortener: false
}
},
email: {
valid: true,
fraud: false, // Also for disposable data.
proxiedEmail: false, // Recommendation: Block users who proxy their email.
freeSubdomain: false,
corporate: true,
email: "[email protected]",
realUser: "admin",
didYouMean: null, // Return a possible email you refer to.
noReply: false,
customTLD: false,
domain: "lamoncloa.gob.es",
roleAccount: true,
plugins: {
blocklist: false,
compromiseDetector: false,
gravatarUrl: null,
mxRecords: [],
nsfw: false,
reachable: {
reachability: "safe",
smtp: {
canConnectSmtp: true,
deliverable: true,
catchAll: false,
disabled: false,
fullInbox: false,
blacklisted: false
}
},
reputation: "governmental", // BETA.
riskScore: 0,
socialFootprint: {
totalChecked: 17,
platforms: [
{
slug: "gravatar",
platform: "Gravatar",
category: "images",
confidence: 100,
metadata: {
avatar: "https://gravatar.com/avatar/...",
name: "John Doe",
username: "johndoe"
}
}
]
},
spam: false,
torNetwork: false,
typosquatting: 0,
urlShortener: false
}
},
phone: {
valid: true,
fraud: false, // Also for disposable data.
phone: "+34617509462",
prefix: "34",
number: "617509462",
lineType: "Unknown",
carrierInfo: {
carrierName: "Vodafone",
accuracy: 50,
carrierCountry: "Spain",
carrierCountryCode: "ES"
},
country: "Spain",
countryCode: "ES",
plugins: {
blocklist: false,
riskScore: 0,
spam: false
}
},
domain: {
valid: true,
fraud: false,
freeSubdomain: false,
customTLD: false,
domain: "test.com",
plugins: {
blocklist: false,.
compromiseDetector: false,
mxRecords: [],
nsfw: false,
reputation: "low", // BETA.
riskScore: 0,
spam: false,
torNetwork: false,
typosquatting: 0, // BETA.
urlShortener: false
}
},
creditCard: {
valid: true,
fraud: false,
test: false,
type: "Mastercard",
creditCard: "5110929780543845",
plugins: {
blocklist: false,
riskScore: 0
}
},
ip: {
valid: true,
type: "IPv4",
class: "A",
fraud: false,
ip: "52.94.236.248",
continent: "North America",
continentCode: "NA",
country: "United States",
countryCode: "US",
region: "VA",
regionName: "Virginia",
city: "Ashburn",
district: "",
zipCode: "20149",
lat: 39.0438,
lon: -77.4874,
timezone: "America/New_York",
offset: -18000,
currency: "USD",
isp: "Amazon.com, Inc.",
org: "Amazon Technologies Inc. (us-east-1)",
as: "AS16509 Amazon.com, Inc.",
asname: "AMAZON-02",
mobile: false,
vpn: true, // BETA - Also used to indicate that it comes from a Data Center.
proxy: false,
hosting: true,
plugins: {
blocklist: false,
riskScore: 0,
spam: false,
torNetwork: false
}
},
wallet: {
valid: true,
fraud: false,
wallet: "1a1zp1ep5qgefi2dmpttl5slmv7divfna",
type: "Bitcoin",
plugins: {
blocklist: false,
riskScore: 0
}
},
userAgent: {
valid: true,
type: "browser",
clientSlug: "chrome",
clientName: "Chrome",
version: "138.0.0.0",
userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
fraud: false,
bot: false,
info: "Chrome v138.0.0.0",
os: "Windows 10.0",
device: {
type: "Desktop",
brand: "Microsoft"
},
plugins: {
blocklist: false,
riskScore: 0
}
},
iban: {
valid: true,
fraud: true,
iban: "ES8101825332130207315465",
bban: "01825332130207315465",
bic: "BBVAESMMXXX", // BETA
country: "Spain",
countryCode: "ES",
accountNumber: "0207315465",
branchIdentifier: "5332",
bankIdentifier: "0182",
plugins: {
blocklist: false,
riskScore: 100
}
}
}