Skip to content

NumberValidateResponse

Source code in docs_src/capo_pinpoint/types/number_validate_response.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class NumberValidateResponse(TypedDict, closed=True):
    carrier: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>"""
    city: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the city where the phone number was originally registered.</p>"""
    cleansed_phone_number_e164: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.</p>"""
    cleansed_phone_number_national: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The cleansed phone number, in the format for the location where the phone number was originally registered.</p>"""
    country: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the country or region where the phone number was originally registered.</p>"""
    country_code_iso2: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>"""
    country_code_numeric: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The numeric code for the country or region where the phone number was originally registered.</p>"""
    county: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the county where the phone number was originally registered.</p>"""
    original_country_code_iso2: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.</p>"""
    original_phone_number: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The phone number that was sent in the request body.</p>"""
    phone_type: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.</p>"""
    phone_type_code: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).</p>"""
    timezone: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The time zone for the location where the phone number was originally registered.</p>"""
    zip_code: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The postal or ZIP code for the location where the phone number was originally registered.</p>"""

carrier instance-attribute 

carrier: NotRequired[__string]

The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

city instance-attribute 

city: NotRequired[__string]

The name of the city where the phone number was originally registered.

cleansed_phone_number_e164 instance-attribute 

cleansed_phone_number_e164: NotRequired[__string]

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

cleansed_phone_number_national instance-attribute 

cleansed_phone_number_national: NotRequired[__string]

The cleansed phone number, in the format for the location where the phone number was originally registered.

country instance-attribute 

country: NotRequired[__string]

The name of the country or region where the phone number was originally registered.

country_code_iso2 instance-attribute 

country_code_iso2: NotRequired[__string]

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

country_code_numeric instance-attribute 

country_code_numeric: NotRequired[__string]

The numeric code for the country or region where the phone number was originally registered.

county instance-attribute 

county: NotRequired[__string]

The name of the county where the phone number was originally registered.

original_country_code_iso2 instance-attribute 

original_country_code_iso2: NotRequired[__string]

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

original_phone_number instance-attribute 

original_phone_number: NotRequired[__string]

The phone number that was sent in the request body.

phone_type instance-attribute 

phone_type: NotRequired[__string]

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

phone_type_code instance-attribute 

phone_type_code: NotRequired[__integer]

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

timezone instance-attribute 

timezone: NotRequired[__string]

The time zone for the location where the phone number was originally registered.

zip_code instance-attribute 

zip_code: NotRequired[__string]

The postal or ZIP code for the location where the phone number was originally registered.