Validate phone number
POSThttps://api.foxentry.com/phone/validate
Foxentry allows you to check validity and the existence of phone numbers. It can also give you additional information about the validated phone number based on the validationType option.
Please pay attention to the formatNumber option. This option defines the format of number that should be considered as valid.
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. Use one of the forms: Separate fields for number and prefix or One field for number with prefix..
Phone number prefix.
Phone number.
Phone number with prefix.
optionsobjectOptions that change how the endpoint behaves.
Type of validation.Default
basicList of allowed prefixes.
Ordered list of preferred prefixes. If phone number is valid with multiple prefixes, the resultCorrected will use the first valid prefix from this list. If not set, the resultCorrected will be null and there will be all valid combinations in the suggestions.
Deprecated - use preferredPrefixes instead. Default international prefix if not part of the query. This is used for the validator to make more accurate results.
Determines whether the formatted phone number (with spaces) should be considered as valid or not. If this option is set to false, a phone number with spaces would be considered as invalid with format error and a correction would be proposed in resultCorrected. If set to true, a phone number with correct use of spaces would be considered as valid and the national format invalid.Default
falseThis 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.
queryobjectSeparate fields for number and prefix
prefixstringPhone number prefix.
numberstringPhone number.
numberWithPrefixstringPhone number with prefix.
optionsobjectQuery options.
validationTypestringType of validation.
basicextendedallowedPrefixesarray[string]List of allowed prefixes.
preferredPrefixesarray[string]Ordered list of preferred prefixes. If phone number is valid with multiple prefixes, the resultCorrected will use the first valid prefix from this list. If not set, the resultCorrected will be null and there will be all valid combinations in the suggestions.
defaultPrefixstring | nullDeprecated - use preferredPrefixes instead. Default international prefix if not part of the query. This is used for the validator to make more accurate results.
formatNumberbooleanDetermines whether the formatted phone number (with spaces) should be considered as valid or not. If this option is set to false, a phone number with spaces would be considered as invalid with format error and a correction would be proposed in resultCorrected. If set to true, a phone number with correct use of spaces would be considered as valid and the national format invalid.
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.
validvalidWithSuggestioninvalidinvalidWithCorrectioninvalidWithPartialCorrectioninvalidWithSuggestioninvalidWithCorrectionWithSuggestionNonedataobjectcountryobjectcodestringCountry code in format ISO-3166-1 alpha-2.
prefixstringCountry phone prefix.
prefixstring | nullCountry phone prefix.
numberstring | nullValidated phone number.
numberWithPrefixstring | nullValidated phone number with prefix.
carrierobjectPhone carrier information.
namestring | nullName of carrier.
typestring | nullType of carrier.
landlinemobilevoipNoneformatobjectStandardized international and local format.
nationalstring | nullNational phone number format.
nationalFormattedstring | nullFormated national phone number.
internationalstring | nullInternational phone number format.
internationalFormattedstring | nullFormated international phone number.
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.resultCorrectedobjectPhone validation result
isValidbooleanDetermines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.
dataobjectcountryobjectcodestringCountry code in format ISO-3166-1 alpha-2.
prefixstringCountry phone prefix.
prefixstring | nullCountry phone prefix.
numberstring | nullValidated phone number.
numberWithPrefixstring | nullValidated phone number with prefix.
carrierobjectPhone carrier information.
namestring | nullName of carrier.
typestring | nullType of carrier.
landlinemobilevoipNoneformatobjectStandardized international and local format.
nationalstring | nullNational phone number format.
nationalFormattedstring | nullFormated national phone number.
internationalstring | nullInternational phone number format.
internationalFormattedstring | nullFormated international phone number.
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 suggested 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.
dataobjectcountryobjectcodestringCountry code in format ISO-3166-1 alpha-2.
prefixstringCountry phone prefix.
prefixstring | nullCountry phone prefix.
numberstring | nullValidated phone number.
numberWithPrefixstring | nullValidated phone number with prefix.
carrierobjectPhone carrier information.
namestring | nullName of carrier.
typestring | nullType of carrier.
landlinemobilevoipNoneformatobjectStandardized international and local format.
nationalstring | nullNational phone number format.
nationalFormattedstring | nullFormated national phone number.
internationalstring | nullInternational phone number format.
internationalFormattedstring | nullFormated international phone number.
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 suggested 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.