🔥 Risk Score Plugin

Get additional information using plugins.

Risk Score Plugin

What is this plugin for?

Our risk assessment plugin will allow you to know the overall risk percentage of the data entered, whether to contact the target, grant access or access the user's website for example.

Usage

Once we have created and configured our API object, it is quite simple, we just need to execute the following code.

import DymoAPI from "dymo-api";

const dymo = new DymoAPI({
  apiKey: ""
});

console.log(await dymo.isValidDataRaw({
  url: "https://test.com/test", 
  email: "[email protected]", 
  phone: "+34617509462", 
  domain: "test.com",
  creditCard: {
      pan: "5110929780543845",
      expirationDate: "01/2030",
      cvv: "123"
  },
  ip: "52.94.236.248",
  wallet: "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
  iban: "ES8101825332130207315465",
  plugins: ["riskScore"]
}));

Algorithm

The Risk Score plugin calculates a confidence score based on both the base response data and the evaluations from other internal plugins.

  • Although this plugin relies on other plugins to determine the risk level, you will not be charged for those internally used plugins.
  • However, since it queries multiple data sources, its response time will be longer than other individual plugins.
  • You won’t see the detailed results of the internal plugins used—unless you explicitly request them in your API call, in which case those plugins will consume credits as usual.

This plugin is ideal when you want a simple risk score without needing to manually interpret multiple plugin responses.

Response

Compatibility:
All data are supported
{
  url: { 
    valid: true,
    fraud: false,
    freeSubdomain: false,
    customTLD: false,
    url: "https://test.com/test",
    domain: "test.com",
    plugins: {
      riskScore: 0
    }
  },
  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: {
      riskScore: 0
    }
  },
  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: {
      riskScore: 0
    }
  },
  domain: { 
    valid: true,
    fraud: false,
    freeSubdomain: false,
    customTLD: false,
    domain: "test.com",
    plugins: {
      riskScore: 0
    }
  },
  creditCard: {
    valid: true,
    fraud: false,
    test: false,
    type: "Mastercard",
    creditCard: "5110929780543845",
    plugins: {
      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: {
      riskScore: 0
    }
  },
  wallet: { 
    valid: true,
    fraud: false,
    wallet: "1a1zp1ep5qgefi2dmpttl5slmv7divfna",
    type: "Bitcoin",
    plugins: {
      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: {
      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: {
      riskScore: 100
    }
  }
}                             

Response type

ParameterType
riskScoreNumber (0-100)