---
agentTools:
  projectIndex: https://docs.defastra.com/llms.txt
---

# Deep Phone Check

Risk scoring with real-time data enrichment for phone numbers.<br>For more details about the social & digital data we return, read our <a target="_blank" href="https://docs.defastra.com/docs/full-data-list">up-to-date data list</a>.<br><h2 class="heading heading-2 header-scroll" align=""><div class="heading-text"><div id="section-general-requirements" class="heading-anchor_backwardsCompatibility"></div>Required headers:</div></h2><ul><li><strong>X-API-KEY:</strong> Your API key <a href="https://docs.defastra.com/reference/authentication"><em>(more info)</em></a></li><li><strong>Content-Type:</strong> <em>application/x-www-form-urlencoded</em> <a href="https://docs.defastra.com/reference/authentication#request-format"><em>(more info)</em></a></li></ul>

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Fraud Prevention Endpoints",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.defastra.com"
    }
  ],
  "tags": [
    {
      "name": "For Phone Numbers"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/deep_phone_check": {
      "post": {
        "tags": [
          "For Phone Numbers"
        ],
        "summary": "Deep Phone Check",
        "description": "Risk scoring with real-time data enrichment for phone numbers.<br>For more details about the social & digital data we return, read our <a target=\"_blank\" href=\"https://docs.defastra.com/docs/full-data-list\">up-to-date data list</a>.<br><h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-text\"><div id=\"section-general-requirements\" class=\"heading-anchor_backwardsCompatibility\"></div>Required headers:</div></h2><ul><li><strong>X-API-KEY:</strong> Your API key <a href=\"https://docs.defastra.com/reference/authentication\"><em>(more info)</em></a></li><li><strong>Content-Type:</strong> <em>application/x-www-form-urlencoded</em> <a href=\"https://docs.defastra.com/reference/authentication#request-format\"><em>(more info)</em></a></li></ul>",
        "operationId": "deep-phone-check",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "required": [
                  "phone"
                ],
                "properties": {
                  "phone": {
                    "type": "string",
                    "example": "12040001234",
                    "description": "The phone number you want to check in international format with the country code"
                  },
                  "timeout": {
                    "type": "string",
                    "enum": [
                      "minimal",
                      "normal",
                      "extensive"
                    ],
                    "default": "normal",
                    "example": "extensive",
                    "description": "The timeout parameters allows you to control the response time of the check, allowing you to choose between more detailed results and faster response times. <a href=\"https://docs.defastra.com/docs/response-time-timeout-settings\"><em>Please read this guide.</em></a>"
                  },
                  "label": {
                    "type": "string",
                    "example": "TEST #45",
                    "description": "A label is any string of text (max. 100 char) that can be attributed to any lookup. They are useful for organizing your data and can be used to search for data in the <a href=\"https://docs.defastra.com/docs/what-is-the-observer\">Observer</a>, or visualize them on the dashboard."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Your request was successful. The response contains a JSON object with our risk analysis & data enrichment. A full real-life example can be seen in the column to the far right.\n\n**Click here to expand the full details**.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"status\":true,\"request_id\":\"B762377D4578D184DE43CC35CFD92BDA\",\"deep_phone_check\":{\"risk_level\":\"low\",\"risk_score\":0,\"phone\":\"33600000000\",\"os\":\"IOS\",\"profiles_count\":5,\"signals\":[{\"result_type\":\"trust\",\"detail\":\"The country of this phone number France (FR) match: Facebook country (FR). \",\"name\":\"PHONE_CONSISTENCY\"},{\"result_type\":\"trust\",\"detail\":\"This phone number was involved in a data breach 3 years ago\",\"name\":\"PHONE_DATA_BREACH\"},{\"result_type\":\"trust\",\"detail\":\"This phone number was not found on any free temporary/disposable SMS services\",\"name\":\"PHONE_DISPOSABLE\"},{\"result_type\":\"trust\",\"detail\":\"The carrier SFR is one of the main mobile carriers in France (FR): Bouygues Telecom, Free, LycaMobile, Orange France, SFR\",\"name\":\"PHONE_CARRIER\"},{\"result_type\":\"trust\",\"detail\":\"This phone was not blacklisted by any 3rd party services\",\"name\":\"PHONE_IS_BLACKLISTED\"},{\"result_type\":\"trust\",\"detail\":\"This phone number type is 'MOBILE'\",\"name\":\"PHONE_TYPE\"}],\"online_profiles\":{\"amazon\":{\"error\":false,\"is_registered\":false},\"instagram\":{\"error\":false,\"is_registered\":true},\"google\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"country\":null,\"country_code\":null,\"gender\":null,\"google_maps_profile\":null,\"in_app_notification\":null,\"last_update\":null,\"name\":null,\"picture_base64\":null,\"profile_url\":null}},\"badoo\":{\"error\":false,\"is_registered\":true},\"battlenet\":{\"error\":false,\"is_registered\":false},\"bumble\":{\"error\":false,\"is_registered\":true},\"microsoft\":{\"error\":false,\"is_registered\":false},\"skype\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"birthday\":null,\"city\":null,\"country\":null,\"country_code\":null,\"gender\":null,\"name\":null,\"picture_base64\":null,\"skype_id\":null}},\"telegram\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"first_name\":null,\"is_verified\":null,\"last_name\":null,\"last_seen\":null,\"picture_base64\":null,\"username\":null}},\"twitter\":{\"error\":false,\"is_registered\":true,\"additional_information\":{\"multiple_accounts\":true}},\"uber\":{\"error\":false,\"is_registered\":true},\"xiaomi\":{\"error\":false,\"is_registered\":false},\"bukalapak\":{\"error\":false,\"is_registered\":false},\"googleduo\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"app_language\":null}},\"kakaotalk\":{\"error\":false,\"is_registered\":false},\"ok\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"location\":null,\"name\":null,\"registered_at\":null}},\"zalo\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"about\":null,\"name\":null,\"picture_base64\":null}},\"yandex\":{\"error\":false,\"is_registered\":false},\"economictimes\":{\"error\":false,\"is_registered\":false},\"tiktok\":{\"error\":false,\"is_registered\":false},\"vk\":{\"error\":false,\"is_registered\":false},\"linkedin\":{\"error\":false,\"is_registered\":false},\"whatsapp\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"about\":null,\"is_business\":null,\"business_category\":null,\"business_name\":null,\"picture_last_modified\":null,\"picture_base64\":null}},\"facebook\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"city\":null,\"country\":null,\"country_code\":null,\"first_name\":null,\"gender\":null,\"hometown\":null,\"last_name\":null,\"picture_base64\":null,\"picture_last_modified\":null,\"profile_url\":null,\"work\":null}},\"line\":{\"error\":true},\"nextdoor\":{\"error\":false,\"is_registered\":false},\"remind\":{\"error\":false,\"is_registered\":false},\"flipkart\":{\"error\":false,\"is_registered\":false},\"gaana\":{\"error\":false,\"is_registered\":false},\"jd\":{\"error\":false,\"is_registered\":false},\"viber\":{\"error\":false,\"is_registered\":false,\"additional_information\":{\"last_seen\":null,\"name\":null,\"picture_base64\":null,\"picture_last_modified\":null}},\"venmo\":{\"error\":false,\"is_registered\":false}},\"carrier\":{\"phone_type\":\"MOBILE\",\"carrier\":\"SFR\",\"main_mobile_carrier\":true,\"main_mobile_carrier_list\":[\"Bouygues Telecom\",\"Free\",\"LycaMobile\",\"Orange France\",\"SFR\"]},\"location\":{\"country_name\":\"France\",\"country_code\":\"FR\",\"country_iso_3\":\"FRA\",\"time_zone\":1,\"city\":null,\"state\":null,\"county\":null,\"latitude\":null,\"longitude\":null},\"data_breaches\":{\"breached\":true,\"breach_count\":1,\"first_breach_date\":\"2019-08-01\",\"what_leaked\":[\"Dates of birth\",\"Email addresses\",\"Employers\",\"Genders\",\"Geographic locations\",\"Names\",\"Phone numbers\",\"Relationship statuses\"],\"breaches\":[{\"breach_name\":\"Facebook\",\"breach_date\":\"2019-08-01\"}]}},\"wallet\":50.12,\"response_time\":3994}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "boolean",
                      "description": "Status of the request, indicating if there is an error or not."
                    },
                    "deep_phone_check": {
                      "type": "object",
                      "description": "JSON object containing the result of the deep check.",
                      "properties": {
                        "risk_level": {
                          "type": "string",
                          "enum": [
                            "low",
                            "medium",
                            "high",
                            "extreme"
                          ],
                          "description": "Simple string representing the overall risk level of the phone number."
                        },
                        "risk_score": {
                          "type": "integer",
                          "description": "A score between ```0``` and ```100```, with ```100``` being the highest level of risk."
                        },
                        "phone": {
                          "type": "string",
                          "description": "The phone number against which the analysis ran"
                        },
                        "profile_found": {
                          "type": "integer",
                          "description": "The count of online profiles we identified registered with this phone number"
                        },
                        "online_profiles": {
                          "type": "object",
                          "description": "Data enrichment results concerning the online profiles linked to this phone number. \n\nRefer to our <a target=\"_blank\" href=\"https://docs.defastra.com/docs/full-data-list#online-profiles-data-for-phone-numbers\">up-to-date list of the data we gather</a>."
                        },
                        "os": {
                          "type": "string",
                          "enum": [
                            "IOS",
                            "ANDROID",
                            "NONE",
                            "ERROR"
                          ],
                          "description": "The live OS we detected linked to the phone number.\n\n<a target=\"_blank\" href=\"https://docs.defastra.com/docs/full-data-list#other-data-for-phone-numbers\">More info here</a>."
                        },
                        "signals": {
                          "type": "array",
                          "description": "Our Deep Phone Check performs various checks against the phone number provided to uncover risks or trust signals. This object contains the details about the signals uncovered.\n\nPlease refer to our <a target=\"_blank\" href=\"https://docs.defastra.com/docs/deep-phone-check-signals\">Deep Phone Check signals page</a> to see a description of each check.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "The technical name of the signal. \n\nPlease refer to our <a target=\"_blank\" href=\"https://docs.defastra.com/docs/deep-phone-check-signals\">Deep Phone Check signals</a> page"
                              },
                              "result_type": {
                                "type": "string",
                                "enum": [
                                  "risk",
                                  "trust"
                                ],
                                "description": "Simple string representing the type of signal"
                              },
                              "detail": {
                                "type": "string",
                                "description": "Message explaining the signals origin"
                              }
                            }
                          }
                        },
                        "carrier": {
                          "type": "object",
                          "description": "All the details concerning the carrier of the phone number",
                          "properties": {
                            "phone_type": {
                              "type": "string",
                              "description": "The type of the phone number",
                              "enum": [
                                "VOIP",
                                "MOBILE",
                                "PREPAID",
                                "FIXED_LINE",
                                "TOLL_FREE",
                                "PAGER",
                                "INVALID",
                                "VOICEMAIL",
                                "RESTRICTED_PREMIUM",
                                "PERSONAL",
                                "OTHER"
                              ]
                            },
                            "carrier": {
                              "type": "string",
                              "description": "The carrier of the phone number"
                            },
                            "main_mobile_carrier": {
                              "type": "boolean",
                              "description": "If the carrier is one of the main mobile carrier in the concerned country"
                            },
                            "main_mobile_carrier_list": {
                              "type": "array",
                              "description": "An array of the most prominent mobile carriers in the concerned country (with a > 1% market share)",
                              "items": {
                                "type": "string",
                                "description": "Carrier name"
                              }
                            }
                          }
                        },
                        "location": {
                          "type": "object",
                          "description": "The location of the phone number",
                          "properties": {
                            "country_name": {
                              "type": "string",
                              "description": "The country name of the phone number"
                            },
                            "country_code": {
                              "type": "string",
                              "description": "The country code of the phone number, ISO-2 representation"
                            },
                            "country_iso_3": {
                              "type": "string",
                              "description": "The country code of the phone number, ISO-3 representation"
                            },
                            "time_zone": {
                              "type": "integer",
                              "description": "The time zone of the phone number location"
                            },
                            "city": {
                              "type": "string",
                              "description": "The city of the phone number. Note, this will return ```null``` if no ```city``` was found by HLR lookup."
                            },
                            "state": {
                              "type": "string",
                              "description": "The country state of the phone number. Note, this will return ```null``` if no country ```state``` was found by HLR lookup."
                            },
                            "county": {
                              "type": "string",
                              "example": "Cook County",
                              "description": "The county of the phone number. Note, this will return ```null``` if no ```county``` was found by HLR lookup."
                            },
                            "latitude": {
                              "type": "number",
                              "description": "The latitude of the city of the phone number. Note, this will return ```null``` if no ```city``` was found by HLR lookup."
                            },
                            "longitude": {
                              "type": "number",
                              "description": "The longitude of the city of the phone number. Note, this will return ```null``` if no ```city``` was found by HLR lookup."
                            }
                          }
                        },
                        "data_breaches": {
                          "type": "object",
                          "description": "This object contains all the information about the presence of the phone number in data breaches",
                          "properties": {
                            "breached": {
                              "type": "boolean",
                              "description": "This value is ```true``` if the phone number was breached, ```false``` otherwise"
                            },
                            "breach_count": {
                              "type": "integer",
                              "description": "Integer representing the number of time a phone number was involved in a data breach"
                            },
                            "first_breach_date": {
                              "type": "string",
                              "description": "The date of the first data breach this phone number was involved in (format ```YYYY-MM-DD```)"
                            },
                            "what_leaked": {
                              "type": "array",
                              "description": "An array of string representing what element linked to the phone number leaked such as ```Address, Email, Location...```",
                              "items": {
                                "type": "string"
                              }
                            },
                            "breaches": {
                              "type": "array",
                              "description": "An array of string representing the name of the data breaches this phone number was involved in, such as ```Facebook 2017, LinkedIn Breach 2016...```",
                              "items": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    "request_id": {
                      "type": "string",
                      "description": "Unique random identifier of the request. It can be used in the <a href=\"https://docs.defastra.com/docs/what-is-the-observer\">Observer</a> to retrieve result"
                    },
                    "wallet": {
                      "type": "number",
                      "description": "Your remaining wallet funds"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "When a request results in error, a 400 HTTP code will always be returned. The response contains details about the error.\n\nProperties of the response: <ul><li><strong>status</strong> : false *(always false when there is an error)*</li><li><strong>error_type</strong> : \"INVALID_API_KEY\" *(Refer to our <a target=\"_blank\" href=\"https://docs.defastra.com/reference/error-handling\">Error handling page</a>)*</li><li><strong>error_message</strong> : \"This API key is invalid.\"</li></ul>",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"status\": false,\"error_message\": \"This API key is invalid.\", \"error_type\": \"INVALID_API_KEY\"}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "boolean",
                      "description": "Indicate if the request succeeded (```false``` indicates an error). It should be checked before acting on the response."
                    },
                    "error_type": {
                      "type": "string",
                      "description": "Short identifier representing the type of error that occured. Present only if a request failed (```status``` is ```false```). Refer to our <a target=\"_blank\" href=\"https://docs.defastra.com/reference/error-handling\">Error handling page</a>."
                    },
                    "error_message": {
                      "type": "string",
                      "description": "Description of the ```error_type```. Present only if a request failed (```status``` is ```false```)."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-enabled": false
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 197,
      "2": 134,
      "3": 96,
      "4": 109,
      "5": 78,
      "6": 1,
      "7": 0,
      "8": 23,
      "9": 237,
      "10": 7,
      "11": 181
    }
  }
}
````