[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"doc-\u002Fdocumentation\u002Fdevice-status\u002Fdevst-getting-started":3},{"docData":4,"isAuthenticated":10,"isTOCHidden":10,"commonDAProps":25},{"id":5,"title":6,"superTitle":7,"description":7,"sectionOrder":8,"slug":9,"isAuthenticated":10,"isTOCHidden":10,"createdAt":11,"updatedAt":12,"publishedAt":13,"environments":14,"isDeprecated":7,"deprecationNoticeTitle":7,"deprecationNotice":7,"documentId":18,"forPartnerDashboard":7,"parent_page":7,"children_pages":19,"pageContent":20},428,"Getting Started",null,9006,"devst-getting-started",false,"2024-09-10T18:17:43.245Z","2025-02-15T03:13:30.940Z","2024-09-10T18:17:50.330Z",[15,16,17],"partner","preprod","production2","j74000ble40u2hnylsrgs2lu",[],[21],{"__component":22,"id":23,"content":24,"referenceURL":7},"content-components.markdown",333,"## Introduction\n\nThe Device Status API allows you to execute a query via T-Mobile's network to your specific device, and retrieve the device's connectivity status, roaming status, and network status. For connectivity status, you can determine whether the device is connected via usage of SMS or Data usage. For roaming status, you can verify whether a device is roaming or not, and in what country said roaming is occurring. Finally, for network status, you can determine if the device is connected to 5GNSA (5G Non-Standalone), or 4G. \n\nThe Device Status API is based on the CAMARA Device Status version 0.6.0; however, T-Mobile's version expands on its definition by providing the network status endpoint.  Additionally, T-Mobile's version does not yet implement event subscriptions or notifications. \n\nDevice status verification is useful for many scenarios, including:\n\n- Regulatory requirements, where a customer may need to be within a certain jurisdiction, or out with others, in order for transactions to be authorized.\n- Security or fraud prevention requirements, to establish that a customer is located where they claim to be, to complete a transaction.\n- Service delivery requirements, to ensure that the customer has access to particular service, potentially warning them if they will incur roaming charges in accessing said services, or to verify that they have the additional bandwidth afforded by 5G networks. \n\n## Pre-Requisites\n\n1. Get an active T-Mobile DevEdge account. You should be able to sign into [https:\u002F\u002Fdevedge.t-mobile.com](\u002F)  and view your dashboard, which lists your current subscriptions.\n2. Subscribe to the Device Status subscription service. Submit your application at [https:\u002F\u002Fdevedge.t-mobile.com\u002Fdevice-status](\u002Fdevice-status) by selecting the _Apply_ button under the desired subscription. Complete the _Apply for Pilot Program Access_ form and click _Submit_ once completed to submit the application. Once approved, you should see a _Subscribe_ option once you return to the page above. Complete the steps to complete your subscription order, and your Device Status Subscription will be shown as active in your dashboard page a few moments after your order is completed.\n\n## Registering your application to use Device Status\n\nDevice Status is designed to integrate your application with secure authorization processes, and to track your usage depending on an application Id.  This allows you to create unique, separate applications targeted to a segment of your customers. \n\nOnce you have an active subscription, create and register your application(s) with DevEdge. To do so, select _Manage Registered Apps_ from the _Software Product Actions_ menu. Then, to add a new application, select _Register Application_. Give your application a name and add a description, create a key pair to encrypt your authentication tokens, and assign an active subscription to the application. Once completed, you can retrieve your application settings to get configuration details. When you create an application, your **clientId** is tied to it, along with a **partnerId**, formatted as an email with a 32-character hexadecimal ID. If you need to change the application details, you can do so from the _Manage Registered Apps_ page. \n\n## Get your API keys\n\nThis is the \"client Secret\" for your application. See [the authentication documentation](\u002Fdocumentation\u002Fapi-fundamentals\u002Fapi-authentication) to understand how to accomplish this step.\n\n## Integrating with the Device Status API\n\nOnce you have met all the prerequisites above, you are ready to integrate the Device Status API with your application. The API provides three endpoints for you to work with:\n\n1. **Get the Current Roaming Status**. This allows to look up whether the device is roaming or not, and in what country. More details are provided [here](\u002Fdocumentation\u002Fdevice-status\u002Fdevst-roam-status).\n2. **Get the Current Network Type**. This allows you to check if your device is connected to 5GSA or 4G.  More details are provided [here](\u002Fdocumentation\u002Fdevice-status\u002Fdevst-net-type).\n3. **Get the Current Connectivity Status**. This allows you to check if the device is currently connected via usage of data or SMS services.  More details are provided [here](\u002Fdocumentation\u002Fdevice-status\u002Fdevst-conn-status).\n\n\n\nLC1.1-SEP10",{"docPagePath":26,"pageName":27},"documentation>device-status>devst-getting-started","documentation"]