Validate email
POSThttps://api.foxentry.com/email/validate
This endpoint will let you check if the e-mail address sent in query is valid.
Please pay attention to the validationType option since it has direct impact on the returned data. Extended validation (default) is the more advanced type that checks the real existence of the e-mail address and its deliverability. It also informs you about various flags such as freemail and disposable mail detection.
Foxentry validator is able not only to evaluate the validity of the inputed information but it also can fix various typos, errors and missing data. Foxentry can also suggest more suitable alternatives to the data sent in query. Please pay attention to the result, resultCorrected and suggestions in the response.
Always check result.proposal in the response for a proposed solution by Foxentry how you should process the response in your form or application.
Headers
Api-VersionstringAuthorizationstringrequiredBody params
requestobjectrequiredCustom ID assigned by you if you need so.
queryobjectrequiredParameters you want to validate or search for.
optionsobjectOptions that change how the endpoint behaves.
Type of validation. Basic = only the format of e-mail is checked and only standard corrections are included. Extended = in depth check of deliverability. Additional information is returned such as temporary mail check or freemail check. More complicated corrections are included.Default
extendedIf true, the disposable e-mails will be marked as valid. Works only in Extended validation.Default
trueIf true, the freemails will be marked as valid. Works only in Extended validation.Default
trueIf true, the e-mails from domains used for phishing will be marked as valid. Works only in Extended validation.Default
trueThis option determines how automatic corrections are handled. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied.Default
fullclientobjectInformation about your user, to make results more relevant.
Country code in ISO-3166-1 alpha-2 format.
Client's latitude
Client's longitude
Empty fields use the example value shown in grey. Everything you type here is written into the request on the right, and the other way round.
Responses
Response body · application/json
statusintegerStatus of API response.
requestobjectendpointstringcodestringCode of request.
customIdstring | nullCustom ID assigned by you if you need so.
queryobjectemailstringoptionsobjectQuery options.
validationTypestringType of validation. Basic = only the format of e-mail is checked and only standard corrections are included. Extended = in depth check of deliverability. Additional information is returned such as temporary mail check or freemail check. More complicated corrections are included.
basicextendedacceptDisposableEmailsbooleanIf true, the disposable e-mails will be marked as valid. Works only in Extended validation.
acceptFreemailsbooleanIf true, the freemails will be marked as valid. Works only in Extended validation.
acceptPhishingDomainsbooleanIf true, the e-mails from domains used for phishing will be marked as valid. Works only in Extended validation.
correctionModestringThis option determines how automatic corrections are handled. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied.
fullformatsuggestionnoneclientobjectAdditional information about your user (from whom you've obtained the data sent in query) to increase relevance of the results. If you do not wish to provide this information, you can limit results to relevant countries using the dataSource parameter present in some modules.
ipstringcountrystringCountry code in ISO-3166-1 alpha-2 format.
locationobjectLatitude & longitude of the client's approximate location.
latnumberClient's latitude
lonnumberClient's longitude
responseobjectresultobjectEvaluation of the sent query.
isValidbooleanDetermines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.
proposalstringProposed solution by Foxentry how you should process the response in your form or application.
validvalidWithSuggestioninvalidinvalidWithCorrectioninvalidWithPartialCorrectioninvalidWithSuggestioninvalidWithCorrectionWithSuggestionunknownWithCorrectionunknownWithPartialCorrectiondataobjectemailstringEmail address.
userstringCustomer user name.
domainstring | nullCustomer domain.
flagsobjectisCatchAllServerboolean | nullDetermines if the domain is set as catchAll. That means no matter what is in front the '@' sign, every e-mail is deliverable
isDisposableEmailAddressboolean | nullDetermines if the email address is disposable.
isFreemailboolean | nullDetermines if the email address is hosted on freemail.
isPhishingDomainboolean | nullDetermines if the email address is a domain used for phishing.
errorsarray[object]List of errors related to the query. Provides information about which query fields were deemed invalid and why.
groupstringGroup of error.
SYNTAXtypestringType of error.
CHARACTERSINVALIDUNABLE_TO_PROCESSVALUE_LENGTHVALUE_PART_EXTRAVALUE_PART_MISSINGsubtypestringSubtype of error.
NOT_ALLOWEDWHITESPACESTOO_LONGTOO_SHORTCONTEXTseveritystringSeverity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.
infowarningcriticalrelatedToarray[string]List of the affected inputs.
descriptionstringDescription of error.
Disallowed characters were used in the value.Value contains invalid use of spaces.Value has invalid syntax.Cannot be processed due to the invalid syntax.Value is too long.Value is too short.Value contains unneccessary context.resultCorrectedobjectEmail validation result
isValidbooleanDetermines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.
dataobjectemailstringEmail address.
userstringCustomer user name.
domainstring | nullCustomer domain.
flagsobjectisCatchAllServerboolean | nullDetermines if the domain is set as catchAll. That means no matter what is in front the '@' sign, every e-mail is deliverable
isDisposableEmailAddressboolean | nullDetermines if the email address is disposable.
isFreemailboolean | nullDetermines if the email address is hosted on freemail.
isPhishingDomainboolean | nullDetermines if the email address is a domain used for phishing.
errorsarray[object]List of errors related to the query. Provides information about which query fields were deemed invalid and why.
groupstringGroup of error.
SYNTAXtypestringType of error.
CHARACTERSINVALIDUNABLE_TO_PROCESSVALUE_LENGTHVALUE_PART_EXTRAVALUE_PART_MISSINGsubtypestringSubtype of error.
NOT_ALLOWEDWHITESPACESTOO_LONGTOO_SHORTCONTEXTseveritystringSeverity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.
infowarningcriticalrelatedToarray[string]List of the affected inputs.
descriptionstringDescription of error.
Disallowed characters were used in the value.Value contains invalid use of spaces.Value has invalid syntax.Cannot be processed due to the invalid syntax.Value is too long.Value is too short.Value contains unneccessary context.fixesarray[object]List of all changes applied to the query data in order to get the corrected result.
groupstringGroup of fix.
FORMATVALUEtypestringType of fix.
CHANGEDsubtypestringSubtype of fix.
CASE_SENSITIVITYDIACRITICSWHITESPACESTYPONonedataobjectData that has been changed
typeFromstringOriginal type of changed value
typestringNew type of value
valueFromstringOriginal value
valuestringChanged value
suggestionsarray[object]Alternatives suggested for the sent query.
isValidbooleanDetermines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.
dataobjectemailstringEmail address.
userstringCustomer user name.
domainstring | nullCustomer domain.
flagsobjectisCatchAllServerboolean | nullDetermines if the domain is set as catchAll. That means no matter what is in front the '@' sign, every e-mail is deliverable
isDisposableEmailAddressboolean | nullDetermines if the email address is disposable.
isFreemailboolean | nullDetermines if the email address is hosted on freemail.
isPhishingDomainboolean | nullDetermines if the email address is a domain used for phishing.
errorsarray[object]List of errors related to the query. Provides information about which query fields were deemed invalid and why.
groupstringGroup of error.
SYNTAXtypestringType of error.
CHARACTERSINVALIDUNABLE_TO_PROCESSVALUE_LENGTHVALUE_PART_EXTRAVALUE_PART_MISSINGsubtypestringSubtype of error.
NOT_ALLOWEDWHITESPACESTOO_LONGTOO_SHORTCONTEXTseveritystringSeverity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.
infowarningcriticalrelatedToarray[string]List of the affected inputs.
descriptionstringDescription of error.
Disallowed characters were used in the value.Value contains invalid use of spaces.Value has invalid syntax.Cannot be processed due to the invalid syntax.Value is too long.Value is too short.Value contains unneccessary context.fixesarray[object]List of all changes applied to the query data in order to get the corrected result.
groupstringGroup of fix.
FORMATVALUEtypestringType of fix.
CHANGEDsubtypestringSubtype of fix.
CASE_SENSITIVITYDIACRITICSWHITESPACESTYPONonedataobjectData that has been changed
typeFromstringOriginal type of changed value
typestringNew type of value
valueFromstringOriginal value
valuestringChanged value
errorsarray[string]List of errors related to the request. Should be empty if the request finished successfully.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.