--- title: "Submits a phone number to the service to be validated and returns the result of the validation." method: POST path: "/phone/validate/v2" tags: ["Phone Validation"] --- # Submits a phone number to the service to be validated and returns the result of the validation. `POST /phone/validate/v2` ## Headers - `Add-Metadata` boolean - `Reference-Id` string - `Timeout-Seconds` integer ## Request body - PhoneValidationV2Request — The request model. - `number` string, required — The phone number that is the subject of the validation. - `output_format` string, nullable — The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code. If not specified, the default format, E164, will be used. - `cache_value_days` integer, nullable — The number of days to look back in cache for the validation result for this phone number. If the result is cached, the response will be returned faster. Acceptable values from 0 (no cache) to 30. If not specified, the default value, 7, will be used. - `country_iso` string, nullable — You can indicate the 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code. - `get_ported_date` boolean — The date the phone number was last ported, returned only if the number has been moved to a different network. This is an optional field and is included only when get_ported_date is set to true, which incurs an additional click. - `get_disposable_number` boolean, nullable — A boolean indicator to attempt to verify if the number is known to be disposable. A disposable number is a shared mobile(or landline) that can be used to receive a text, or phone call. - `supplementary_live_status` PhoneValidationV2SupplementaryLiveStatus — The supplementary live status request model. Please note that this feature has additional charge if requested. - `mobile` string[], nullable — An indicator to attempt to get supplementary live status for Mobile Phone Number. - `landline` string[], nullable — An indicator to attempt to get supplementary live status for Landline Phone Number. ## Response `200` OK - PhoneValidationV2Response — The response model. - `error` ResponseError — Error model containing the error details. - `type` string, nullable — A link to documentation that provides more details about the error you’ve encountered. - `title` string, nullable — The title of the error. - `detail` string, nullable — A description of the error. - `instance` string, nullable — The endpoint that returned the error. - `result` PhoneValidationV2Result — Details about the result. Includes the validated data and its confidence level. - `number` string, nullable — The phone number that is the subject of the validation. - `validated_phone_number` string, nullable — The validated phone number. Also includes the international country calling code. Note that this field is returned even if the phone number has a confidence status of "Invalid". - `formatted_phone_number` string, nullable — The phone number in the format you specified in "output_format". - `phone_type` string, nullable — The type of phone number. Note: Landline is only supported in North America. - `confidence` 'Verified' | 'Absent' | 'Teleservice not provisioned' | 'Unverified' | 'No coverage' | 'Unknown' | 'Dead' — The outcome (confidence level) of the validation. - `ported_date` string, nullable — The date the phone number was last ported, returned only if the number has been moved to a different network. This is an optional field and is included only when get_ported_date is set to true, which incurs an additional click. - `disposable_number` string, nullable — Indicates whether the phone number is a disposable number based on lookup list of disposable numbers. If the number can be found in the lookup list, the value returned will be "Yes". Otherwise, the value returned will be "Unknown". This value would be returned if the get_disposable_number boolean is set to true. - `metadata` PhoneValidationV2Metadata — The metadata model. - `code` string, nullable — Ignore, currently not used. - `message` string, nullable — Ignore, currently not used. - `phone_detail` PhoneValidationV2PhoneDetail — Metadata fields and values that can be returned, in addition to the main core information. - `original_operator_name` string, nullable — The name of the MSISDN operator where the phone number was originally registered. - `original_network_status` string, nullable — The status of the network where the phone number was originally registered. - `original_home_network_identity` string, nullable — The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number was originally registered. - `original_country_prefix` string, nullable — The international calling code of the country where the phone number was originally registered. - `original_country_name` string, nullable — The name of the country where the phone number was originally registered. - `original_country_iso` string, nullable — The 3-letter ISO code of the country where the phone number was originally registered. - `operator_name` string, nullable — The name of the MSISDN operator where the phone number is currently registered. - `network_status` string, nullable — The status of the network where the phone number is currently registered. - `home_network_identity` string, nullable — The Mobile Country Code (MCC) and Mobile Network Code (MNC) where the phone number is currently registered. - `country_prefix` string, nullable — The international calling code of the country where the phone number is currently registered. - `country_name` string, nullable — The name of the country where the phone number is currently registered. - `country_iso` string, nullable — The 3-letter ISO code of the country where the phone number is currently registered. - `is_ported` string, nullable — Indicates whether the phone number is ported or not. - `cache_value_days` integer, nullable — The requested number of days to look back in the cache for this phone number. - `date_cached` string, nullable — The last date this phone number was checked. - `email_to_sms_address` string, nullable — Email address which can be used to send SMS messages to this phone number. - `email_to_mms_address` string, nullable — Email address which can be used to send MMS messages to this phone number. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `406` — Not Acceptable - `408` — Request Timeout - `415` — Unsupported Media Type - `429` — Too Many Requests - `500` — Internal Server Error - `503` — Service Unavailable --- [API](https://skmtc.dev/experianaperture/apis/aperture-rest-api.md) · [All operations](https://skmtc.dev/experianaperture/apis/aperture-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/experianaperture/aperture-rest-api/revisions/f17d329b4892/schema)