Email Verification

Email verification can contain details such as whether an email is valid/invalid as well as if it's disposable and role based.

Minimum Requirements

The following table lists the minimum inputs required to make a valid request for an Email Verification Check:

Response	Description
Email Address	Fully formed email address

Service Request

To request for an Email Verification, add a EMAIL_VERIFICATION action to the request body entity PeopleActionsRequest:

{
    "actions": [
        { "action": "EMAIL_VERIFICATION" }
    ]
}

PeopleActionsRequest

	Array of objects (PersonAction) Actions to run with the given criteria
	object (PersonRequest) Person format used across the Investigate API
	object (Address) Address format used across the Investigate API
cohabitants	Array of strings (Cohabitants) Cohabitants at given address
sourceYears	Array of integers <int32> (SourceYears) [ items <int32 > ] Years when the matching datasets stored by GBG were issued. This could support customers compliance requirements.
tags	Array of strings Free text tags for tracking purposes.

{

• "actions": [

  • {

    • "action": "EMAIL_VERIFICATION"

    }

  ],
• "person": {

  • "firstName": "string",
  • "middleNames": [

    • "James"

    ],
  • "lastNames": [

    • "Smith"

    ],
  • "dateOfBirth": {

    • "day": 31,
    • "month": 12,
    • "year": 1981

    },
  • "gender": "U",
  • "phones": [

    • "+44 207 4281250"

    ],
  • "emails": [

    • "investigate@gbgplc.com"

    ],
  • "ageBand": {

    • "min": 31,
    • "max": 32

    }

  },
• "address": {

  • "premise": "128",
  • "building": "string",
  • "subBuilding": "string",
  • "thoroughfare": "Queen Victoria Street",
  • "locality": "London",
  • "postalCode": "EC4V 4BJ",
  • "country": "GBR"

  },
• "cohabitants": [

  • "John",
  • "Rita M Brown",
  • "Mary Williams"

  ],
• "sourceYears": [

  • 2021,
  • 2022

  ],
• "tags": [

  • "CASE_NUMBER=123",
  • "IMPORTANT"

  ]

}

Service Response

As part of the PersonActionsResponse entity, the property emailVerification contains the results of the request.

EmailVerificationActionResponse

	Array of objects (EmailVerificationAction)
	object (Meta) Metadata describing the response produced.

{

• "result": [

  • {

    • "email": "string",
    • "result": "CANT_VERIFY",
    • "reason": [

      • "string"

      ],
    • "isDisposable": true,
    • "isRole": true,
    • "risk": "UNKNOWN"

    }

  ],
• "meta": {

  • "traceId": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
  • "timestamp": "2019-01-04T14:38:25Z",
  • "investigationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFjZUlkIjoiMTIzNDU2IiwibWF0Y2hJZHMiOltdLCJleHAiOjE1MTYyMzkwMjJ9.3SZoV56G0HT289QqP04OT5F1ITtsMqRCGkPok2-st50"

  }

}

If no Email Verification has been requested, the response is empty.

If an Email Verification has been requested, the following response is available:

		Description
emailVerification	email	The email address supplied
	result	The response is based on the status supplied through the Contact Verification Result.