IMEI Service - GET T-Mobile Eligibility
Create Token for API Authentication
To access Phonecheck API resources, you must log in and retrieve a token.
Token Info
The token may vary in length or format.
Token lifetime is 24 hours from creation.
You must place the authentication token into the
header
, orquery
, astoken_master
.
Examples:
As a query parameter:
https://api.phonecheck.com/v2/imei/tmobile/<IMEI Number>?token_master=<Token>
As a header:
URL: https://api.phonecheck.com/v2/imei/tmobile/<IMEI Number>
Header: token_master: <Token>
License Information
Master accounts must have ESN Licenses assigned for API service to work.
Each carrier eligibility response equals 1 ESN license consumption.
This service can consume 1 ESN license at this time.
When the response is
fromCache true
the service will not deduct a license.
Request
Method: GET
Query: https://api.phonecheck.com/v2/imei/tmobile/<IMEI Number>
Replace <IMEI Number> with an IMEI number.
Response
Type: object
Fields:
data
, objecttmobileEligibility
, string, optional. Possible values: "Clean", “Lost or stolen", “Clean - Device under contract", “Blocked".
eligible
, string. Possible values:“Financial issues reported"
,“No financial issues reported"
,“Financial issues not checked"
.imei
, string. The IMEI queried.
fromCache
, boolean. Whether the result was obtained from the cache.
Sample API Response
If authentication is successful, you will receive a response from T-Mobile.
Status: 200
{
"data": {
"imei": "357061228981735",
"model": "iPhone 12 Pro Max",
"modelInfo": "Apple A2342 iPhone 12 Pro Max (US)",
"manufacturer": "Apple",
"esimSupported": "Yes",
"tmobileEligibility": "Clean"
},
"serviceProviders": [
{
"serviceId": "4",
"provider": "saturn"
}
],
"fromCache": false
}
Error Response
If your username or password is invalid, or there is a system error, you will receive an Errored Response
Status: 401
{
"msg": "Missing authentication token"
}
Status: 500
{
"msg": "failed to validate token"
}