LogoLogo
  • API Documentation
  • Authentication
  • Testing
  • Contact Support
  • System Status
  • VX
    • Create Session
    • API Methods
  • Agematch
    • United States
    • United States (DMV)
    • International
    • With KBA Quiz
    • Selfie Age Estimation
  • IDMATCH
    • United States
      • With KBA Escalation
      • KYC/CIP Compliance
      • COPPA Compliance
    • International
  • idmatch+
    • United States
  • IDMATCH+PREDICT
    • Fraud Score
  • phonematch
    • Verification and Validation
      • Smart 2FA
      • Phone Verification
      • Phone Validation
    • One Time Passwords
      • SMS
      • Call
    • Message Delivery
      • Dialer
  • emailmatch
    • Email Validation
  • dcams
    • Document Capture and Management Services
      • Scanning Basic
      • Scanning Enhanced
      • Manual Review
      • Storage
        • Create or Update a Customer
        • Get Customer Status
        • Get Customer Document Images
        • Update Customer Status
      • iFrame
        • Canned Responses
        • Create Token
        • View Callback
        • User Status
        • Generate Link
      • Swift SDK
      • Android SDK
  • Bouncer
    • Overview
    • Bouncer as an add-on
  • V-PIN
    • Overview
    • V-PIN as an add-on
    • V-PIN Stand Alone
  • Service Coverage
    • Data Coverage
  • Testing
    • Test Cases
    • Answers to KBA Questions
  • Reporting
    • Audit
  • API Processing Errors
    • Error Returns
  • Knowledge Base
    • Best Practices
    • Understanding Veratad Services
  • IDMax
    • IDMax Button Creator SDK
Powered by GitBook
On this page
  • EmailMatch5.0.Validate
  • Sample Request Body
  • Action and Detail Responses
  • Issues Responses
  • Rules
  • API Processing Error Returns
  1. emailmatch

Email Validation

Email validation and risk profiling.

EmailMatch5.0.Validate

POST https://production.idresponse.com/process/comprehensive/gateway

Make an HTTPS POST request with the following body parameters to find out if the target has provided a valid and non high risk email address. You will receive a synchronous response in 2-3 seconds with a result object that includes an action, detail and issues object.

Request Body

Name
Type
Description

user

string

Your account's API username

pass

string

Your account's API password

service

string

The service name (EmailMatch5.0.Validate)

reference

string

A unique identifier for your customer

target

object

The individual being sent for verification

email

string

The target's email address

{
    "meta": {
        "confirmation": 68651625,
        "reference": null,
        "service": "EmailMatch5.0",
        "timestamp": "2019-10-25 13:48:21",
        "company": "Company, LLC",
        "user": "user@company.com"
    },
    "result": {
        "action": "REVIEW",
        "detail": "TRANSACTION REQUIRES FURTHER ATTENTION",
        "issues": [
            "EMAIL DELIVERY UNKNOWN"
        ]
    }
}

Sample Request Body

{
    "user": "USERNAME",
    "pass": "PASSWORD",
    "service": "EmailMatch5.0.Validate",
    "target": {
        "email": "test@veratad.com"
    }
}

Action and Detail Responses

The following are all values that will be returned in the result object of the response.

Action

Detail

Description

FAIL

EMAIL DELIVERY CHECK FAILED

The email address is not deliverable

FAIL

EMAIL RISK CHECK FAILED

The email address risk is high

REVIEW

TRANSACTION REQUIRES FURTHER ATTENTION

The email has one of the below issues

PASS

ALL CHECKS PASSED

The email address is deliverable and there are no issues

Issues Responses

When a transaction returns as REVIEW then there will be a list of issues. This list can include any of the below values.

Issue

Description

EMAIL RISK IS MEDIUM

The email address has been detected as deliverable, but with medium risk

EMAIL RISK IS UNKNOWN

The email address has been detected as deliverable, but with an unknown risk

Rules

EmailMatch+Validate will process with the default base ruleset. Here are the rules:

The base ruleset will return a PASS when:

  • The email address is deliverable

  • The email address is low risk

The base ruleset will return a REVIEW when:

  • The email address is deliverable

  • The email address has medium risk

  • The email address has an unknown risk

The base ruleset will return a FAIL when:

  • The email address is not deliverable

  • The email address is high risk

API Processing Error Returns

PreviousDialerNextDocument Capture and Management Services

Last updated 5 years ago

Error Returns