Umbrella Docs
© 2024 IDCanopy Flexco

Phone Intelligence

Live check of a phone numbers status


Phone Status Check

Phone Status Check allows you to get global phone number and subscriber data intelligence to strengthen authentications, evaluate fraud risks, and enhance the user experience.

The basic Phone Status Check product cleans and reformats a submitted phone number and then returns phone device-type, telecom carrier name, and phone registration information

Version: 1.0.0

Contact information:
IDCanopy Support
support@idcanopy.com

/phoneid

** API Endpoint:** https://web-umbrella-api.azurewebsites.net/phoneid

Method: POST

Headers

Content-TypeValue
Content-Typeapplication/json

Body (raw)

{
    "phone": "+436504142107"
}

🔑 Authentication bearer

ParamvalueType
tokenstring

Response: 200

{
    "reference_id": "36475B3EB1DC0C2492E2889F4EACF2CC",
    "sub_resource": "live",
    "status": {
        "code": 300,
        "description": "Transaction successfully completed",
        "updated_on": "2024-09-09T12:43:42.701105Z"
    },
    "errors": [],
    "phone_type": {
        "code": "2",
        "description": "MOBILE"
    },
    "blocklisting": {
        "blocked": false,
        "block_code": 0,
        "block_description": "Not blocked"
    },
    "numbering": {
        "cleansing": {
            "call": {
                "country_code": "43",
                "phone_number": "6504142107",
                "cleansed_code": 100,
                "min_length": 7,
                "max_length": 13
            },
            "sms": {
                "country_code": "43",
                "phone_number": "6504142107",
                "cleansed_code": 100,
                "min_length": 7,
                "max_length": 13
            }
        },
        "original": {
            "complete_phone_number": "+436504142107",
            "country_code": "43",
            "phone_number": "6504142107"
        }
    },
    "location": {
        "city": "Countrywide",
        "state": null,
        "zip": null,
        "metro_code": null,
        "county": null,
        "country": {
            "name": "Austria",
            "iso2": "AT",
            "iso3": "AUT"
        },
        "coordinates": {
            "latitude": null,
            "longitude": null
        },
        "time_zone": {
            "name": null,
            "utc_offset_max": "+1",
            "utc_offset_min": "+1"
        }
    },
    "carrier": {
        "name": "Mass Response Service GmbH"
    },
    "live": {
        "subscriber_status": "ACTIVE",
        "device_status": "REACHABLE",
        "roaming": "UNAVAILABLE",
        "roaming_country": null,
        "roaming_country_iso2": null
    }
}