Protected Devices 📱
This page details all the endpoints to fetch devices protected by or linked to a plan.
Fetch Protected Devices
Link Device (To Be Protected) to Plan
POST https://api.getgamp.com/v1/protected-device/link
This allows the linking of a device to be protected to a plan.
Request Body
planId*
String
The planId of the plan the protected device is to be linked to.
deviceType*
String
'phone', 'tablet' or 'laptop'
deviceBrand*
String
The brand of the device e.g 'samsung', 'iphone', 'oppo' etc.
deviceModel*
String
The model of the device e.g 13 Pro, A52, C300 etc.
uniqueDeviceNumber*
String
The unique device number of the device issued by the manufacturer e.g IMEI etc.
deviceId
String
Your desired unique ID linked to the device. It is auto-generated if not provided. Not to be confused with IMEI
{
"success": true,
"message": 'Device Linking Request Generated. Please, Proceed to Upload Verification Video',
"data": {
activationId: "dev90939f893hhiuwne",
deviceId: "dev90939f893hhiuwne",
createdAt: "2022-09-28T23:23:48.108Z",
deviceType: "phone",
planId: "dpp0239028923483943",
uid: "99f0j3ru3rfuh3urfh3r",
status: 'incomplete',
remainingDevices: 2,
},
"statusCode": 200
}Upload Device Verification Video
POST https://api.getgamp.com/v1/protected-device/verification/upload
This allows the upload of a device verification video to aid approval of the linked device to the plan.
Request Body
video*
File
The recorded verification video
deviceId*
String
The unique deviceId linked to the device during link
{
"success": true,
"message": "Verification Video Uploaded Successfully",
"data": {
"deviceId": "dev53822120230713195436",
"uploaded": true,
"recorded": true
},
"statusCode": 200
}Fetch Protected Devices
GET https://api.getgamp.com/v1/protected-device/:deviceId
Fetch a plan
Path Parameters
deviceId*
String
The deviceId assigned by Gamp to the protected device
Headers
Authorization
String
Set value to Bearer SECRET_KEY
{
"success": true,
"message": "Device Fetched Successfully",
"data": {
"customer": {
"email": "[email protected]",
"phoneNumber": "08464732853859953"
},
"_id": "6217c05bd02733af3938aed7",
"uid": "srykawzs20220224182857",
"businessId": "bus9076412022027132655",
"channel": "API",
"product": "device_protection_plan",
"planType": "basic",
"planId": "dpp27774620220224182859",
"activationId": "dev27995020220224182859",
"reference": "s21h1fr202202241828",
"createdAt": "2022-02-24T17:28:57.504Z",
"expiryDate": "2023-02-24T17:28:57.504Z",
"duration": 12,
"price": 72000,
"token": "o23i20220224182859",
"listOfTokens": [],
"status": "pending",
"email": "[email protected]",
"phoneNumber": "08464732853859953",
"deviceType": "phone",
"deviceBrand": "iPhone",
"deviceModel": "X",
"deviceLinked": true,
"uniqueDeviceNumber": "ux84683gh39rh39",
"history": [
{
"action": "Device Linking Request Auto-generated",
"actionBy": "[email protected]",
"reason": "",
"uid": "srykawzs20220224182857",
"createdAt": "2022-02-24T17:28:59.510Z",
"_id": "6217c05bd02733af3938aed8"
}
],
"claims": [],
"verified": false,
"invalid": false,
"__v": 0
},
"statusCode": 200
}curl --request GET 'https://api.getgamp.com/v1/protected-device/s21h1fr202202241828' \
--header 'Authorization: Bearer SECRET_KEYList Protected Devices
GET https://api.getgamp.com/v1/protected-device
Fetch a list of plans
Query Parameters
reference
String
The reference you specified or we assigned to the plan linked to this protected device
planType
String
"device_protection_plan" or "screen_protection_plan"
product
String
"device_protection_plan" or "screen_protection_plan"
cuid
String
The unique ID you specified for or we assigned to the customer's profile
String
The user's email address
planId
String
The ID we assigned to the plan.
deviceId
String
The activationId we assigned to the protected device
activationId
String
The activationId we assigned to the protected device
Headers
Authorization
String
Set value to Bearer SECRET_KEY
{
"success": true,
"message": "Devices Fetched Successfully",
"data": {
"docs": [
{
"customer": {
"email": "[email protected]",
"phoneNumber": "08464732853859953"
},
"_id": "6217c05bd02733af3938aed7",
"uid": "srykawzs20220224182857",
"businessId": "bus9076412022027132655",
"channel": "API",
"product": "device_protection_plan",
"planType": "basic",
"planId": "dpp27774620220224182859",
"activationId": "dev27995020220224182859",
"reference": "s21h1fr202202241828",
"createdAt": "2022-02-24T17:28:57.504Z",
"expiryDate": "2023-02-24T17:28:57.504Z",
"duration": 12,
"price": 72000,
"token": "o23i20220224182859",
"listOfTokens": [],
"status": "pending",
"deviceType": "phone",
"deviceBrand": "iPhone",
"deviceModel": "X",
"deviceLinked": true,
"uniqueDeviceNumber": "ux84683gh39rh39",
"claims": [],
"verified": false,
"invalid": false,
"__v": 0
},
{
"customer": {
"email": "[email protected]",
"phoneNumber": "08464732853859953"
},
"_id": "62172c6428656e2d2159a4b5",
"uid": "vxp7uuw120211129184515",
"businessId": "bus9076412022027132655",
"channel": "API",
"metadata": {
"uid": "3248485930593583"
},
"product": "device_protection_plan",
"planType": "basic",
"planId": "dpp8802992022022475737",
"activationId": "dev7016742022022475740",
"reference": "wr0qey220220224757",
"createdAt": "2022-02-24T06:57:36.856Z",
"expiryDate": "2022-08-24T06:57:36.856Z",
"duration": 6,
"price": 30000,
"token": "007m2022022475737",
"listOfTokens": [],
"status": "pending",
"deviceType": "laptop",
"deviceBrand": "samsung",
"deviceModel": "A50",
"deviceLinked": true,
"uniqueDeviceNumber": "slbfvuhhg39gh39rh39",
"claims": [],
"verified": false,
"invalid": false,
"__v": 0
}
]
},
"statusCode": 200
}curl --request GET 'https://api.getgamp.com/v1/protected-device' \
--header 'Authorization: Bearer SECRET_KEYLast updated