Verification

{
  "temporaryEmail": true,
  "emailRiskScore": 100,
  "vpn": true,
  "ipType": "residential",
  "country": "United States",
  "ipRiskScore": 66,
  "action": "deny",
  "reasons": ["temporary_email", "vpn_ip"]
}

{
  "temporaryEmail": true,
  "emailRiskScore": 100,
  "action": "deny",
  "reasons": ["temporary_email_domain"]
}

Action types allow - The user is considered safe

quarantine - Trueguard strongly suspects the email might be temporary, but isn't completely certain. Limiting access or manual review is recommended. This usually occurs with temporary emails from Gmail, Hotmail, etc. where email name patterns are analyzed.

deny - Trueguard is sure that the email, domain, or IP address is suspicious and that user access to the service should be denied or reviewed.

PreviousAPI Reference

Last updated 13 days ago

Perform verification

POST/verification

Body

email*string (email)

type*enum

basefull

ipnullable string

Response

Successful verification

Body

idstring

Example: "ea9d4f53-c803-4416-b1f4-ec520666f115"

temporaryEmailboolean

Example: true

emailRiskScorenumber

Example: 100

vpnboolean

Example: false

ipTypeenum

Example: "residential"

residentialbusinesswirelessnull

countrystring

Example: "Estonia"

ipRiskScorenumber

Example: 0

actionenum

Example: "deny"

allowquarantinedeny

reasonsarray of enum

Example: "temporary_email_domain"

Request

const response = await fetch('/verification', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "rocnag@tempumail.show",
      "type": "full",
      "ip": "1.2.3.4"
    }),
});
const data = await response.json();

Response

{
  "id": "ea9d4f53-c803-4416-b1f4-ec520666f115",
  "temporaryEmail": true,
  "emailRiskScore": 100,
  "vpn": false,
  "ipType": "residential",
  "country": "Estonia",
  "ipRiskScore": 0,
  "action": "deny",
  "reasons": "temporary_email_domain"
}