Verification

Perform verification

post

Body

application/json

emailstring · emailRequired

typestring · enumRequiredPossible values:

ipstring · nullableOptional

Responses

200

Successful verification

application/json

idstringOptionalExample: ea9d4f53-c803-4416-b1f4-ec520666f115

temporaryEmailbooleanOptionalExample: true

emailRiskScorenumberOptionalExample: 100

vpnbooleanOptionalExample: false

ipTypestring · enumOptionalExample: residentialPossible values:

countrystringOptionalExample: Estonia

ipRiskScorenumberOptionalExample: 0

actionstring · enumOptionalExample: denyPossible values:

post

/verification

HTTPcURLJavaScriptPython

POST /verification HTTP/1.1
Host: api.trueguard.io
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "email": "[e-mail]",
  "type": "full",
  "ip": "1.2.3.4"
}

200

Successful verification

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

200 with IP example

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

200 without IP example

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.