gamp API Documentation
  • Welcome! 😎
  • API Doc
    • Getting Started πŸƒπŸΎβ€β™‚οΈ
      • Signup 🎊
      • API Dashboard πŸ–₯
      • Setup Business Profile πŸ“‡
      • Profile Verification βœ…
    • Introduction
    • Environments βš™οΈ
    • Products 🎁
      • Device Protection Plan πŸ’»
        • Custom Plan
      • Screen Protection Plan πŸ“± (to be deprecated)
      • Repairs πŸ› οΈ
    • Definitions πŸ“’
  • Reference
    • API Reference
      • Authentication πŸ”
      • Error ⚠️
      • Endpoints
        • Plans πŸ›’
        • Protected Devices πŸ“±
        • ClaimsπŸ‘¨πŸ½β€πŸ”§
        • Repairs πŸ› οΈ
    • πŸ“ƒAPI Change Log
Powered by GitBook
On this page
  • Make a Claim
  • Fetch Claims
  • Fetch Claim
  • List Claims
  1. Reference
  2. API Reference
  3. Endpoints

ClaimsπŸ‘¨πŸ½β€πŸ”§

This page details all the endpoints for making a claim and monitoring the claims.

After a customer has bought a plan and the customer's device has been linked, the customer can claim the plan for the device when the device gets damaged. We process the claim and make a decision to fix or replace the damaged component of the device.

Make a Claim

POST https://api.getgamp.com/v1/claim/make

Create a new plan

Headers

Name
Type
Description

authorization*

String

Set value to Bearer SECRET_KEY

Request Body

Name
Type
Description

activationId*

String

The activationId, reference or deviceId returned on the protected device's object

issue*

String

The summary of the damage the device

description

String

Detailed description of the problem the device has

cuid*

String

Customer ID of the customer making the claim

{
    "success": true,
    "message": "Claim Submitted Successfully",
    "data": {
        "businessId": "bus9076412022027132655",
        "clientId": "um8d2022dxqxnn6a0219",
        "cuid": "reu93kbp2022022541553",
        "channel": "API",
        "uid": "vqlyhe0e2022022541553",
        "token": "vn072022022541826",
        "product": "device_protection_plan",
        "planType": "premium",
        "planId": "dpp0603912022022541826",
        "activationId": "dev5466172022022541826",
        "claimId": "cla096530202202254286",
        "createdAt": "2022-02-25T03:28:06.604Z",
        "issue": "Broken Screen",
        "description": "Phone fell down",
        "status": "pending",
        "statusNo": "1",
        "customer": {
            "email": "t+238483@getgamp.com",
            "phoneNumber": "080407485857"
        },
        "deviceType": "phone",
        "deviceBrand": "iPhone",
        "deviceModel": "11",
        "uniqueDeviceNumber": "g7hf85f939rh39",
        "claimProcessed": false,
        "reference": "nzpwksl20220225418"
    },
    "statusCode": 200
}
{
    "statusCode": 401,
    "message": "Unauthorized"
}
curl --request POST 'https://api.getgamp.com/v1/claim/make' \
--header 'Authorization: Bearer SECRET_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "activationId": "dev5466172022022541826", 
    "cuid": "reu93kbp2022022541553",
    "issue": "Broken Screen", 
    "description": "Phone fell down"
}'
{
    "success": true,
    "message": "Claims Fetched Successfully",
    "data": {
        "businessId": "bus9076412022027132655",
        "clientId": "um8d2022dxqxnn6a0219",
        "cuid": "reu93kbp2022022541553",
        "channel": "API",
        "uid": "vqlyhe0e2022022541553",
        "token": "vn072022022541826",
        "product": "device_protection_plan",
        "planType": "premium",
        "planId": "dpp0603912022022541826",
        "activationId": "dev5466172022022541826",
        "deviceId": "dev8358592021121692629",
        "claimId": "cla096530202202254286",
        "createdAt": "2022-02-25T03:28:06.604Z",
        "issue": "Broken Screen",
        "description": "Phone fell down",
        "status": "pending",
        "statusNo": "1",
        "customer": {
            "email": "t+238483@getgamp.com",
            "phoneNumber": "080407485857"
        },
        "deviceType": "phone",
        "deviceBrand": "iPhone",
        "deviceModel": "11",
        "uniqueDeviceNumber": "g7hf85f939rh39",
        "claimProcessed": false,
        "reference": "nzpwksl20220225418"
    },
    "statusCode": 200
}

Fetch Claims

Fetch Claim

GET https://api.getgamp.com/v1/claim/:deviceId

Fetch a plan

Path Parameters

Name
Type
Description

deviceId*

String

The deviceID linked to the plan

Headers

Name
Type
Description

authorizaion*

String

Set value to Bearer SECRET_KEY

{
    "success": true,
    "message": "Claim Fetched Successfully",
    "data": {
                "_id": "61fc50e7764bd1729d84d06b",
                "claimProcessed": false,
                "uid": "vxp7uuw120211129184515",
                "token": "mjx7202112169253",
                "planType": "basic",
                "reference": "fjdfndbkhvdbkf84nfs",
                "planId": "spp596363202112169253",
                "activationId": "ACT8358592021121692629",
                "deviceId": "dev8358592021121692629",
                "claimId": "cla090494202202323214",
                "createdAt": "2022-02-03T22:02:14.466Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "laptop",
                "deviceBrand": "HP",
                "deviceModel": "Elitebook e50",
                "uniqueDeviceNumber": "jsnulmdssdklfhvjhvu36f",
                "__v": 0
            }
    },
    "statusCode": 200
}
{
    "statusCode": 401,
    "message": "Unauthorized"
}
curl --request GET 'https://api.getgamp.com/v1/claim/dev8358592021121692629' \
--header 'Authorization: Bearer SECRET_KEY'
{
    "success": true,
    "message": "Claim Fetched Successfully",
    "data": {
                "_id": "61fc50e7764bd1729d84d06b",
                "claimProcessed": false,
                "uid": "vxp7uuw120211129184515",
                "token": "mjx7202112169253",
                "planType": "basic",
                "reference": "fjdfndbkhvdbkf84nfs",
                "planId": "spp596363202112169253",
                "activationId": "ACT8358592021121692629",
                "deviceId": "dev8358592021121692629",
                "claimId": "cla090494202202323214",
                "createdAt": "2022-02-03T22:02:14.466Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "laptop",
                "deviceBrand": "HP",
                "deviceModel": "Elitebook e50",
                "uniqueDeviceNumber": "jsnulmdssdklfhvjhvu36f",
                "__v": 0
            }
    },
    "statusCode": 200
}

List Claims

GET https://api.getgamp.com/v1/claim

Fetch a list of claims

Query Parameters

Name
Type
Description

planId

String

ID of plan linked to the claims

activationId

String

The activationId of the protected device linked to the claim

deviceId

String

The deviceId of the protected device linked to the claim

email

String

The email of the customer linked to the claim.

cuid

String

The unique ID you specified for or we assigned to the profile of the customer linked to the claim

claimId

String

The unique ID for a claim

Headers

Name
Type
Description

Authorization*

String

Set value to Bearer SECRET_KEY

{
    "statusCode": 401,
    "message": "Unauthorized"
}
{
    "success": true,
    "message": "Claims Fetched Successfully",
    "data": {
        "docs": [
            {
                "_id": "61fc50e7764bd1729d84d06b",
                "claimProcessed": false,
                "uid": "vxp7uuw120211129184515",
                "token": "mjx7202112169253",
                "planType": "basic",
                "planId": "spp596363202112169253",
                "activationId": "ACT8358592021121692629",
                "claimId": "cla090494202202323214",
                "createdAt": "2022-02-03T22:02:14.466Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "laptop",
                "deviceBrand": "HP",
                "deviceModel": "Elitebook e50",
                "uniqueDeviceNumber": "jsnulmdssdklfhvjhvu36f",
                "__v": 0
            },
            {
                "_id": "61f2b04c9e113200160956ab",
                "claimProcessed": false,
                "uid": "s4j2r55v202201271459",
                "token": "9p8u2022012714628",
                "planType": "basic",
                "planId": "dpp3395282022012714628",
                "activationId": "ACT5842682022012714713",
                "claimId": "cla82163820220127144636",
                "createdAt": "2022-01-27T14:46:36.539Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348136578976",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "12",
                "uniqueDeviceNumber": "124567890",
                "__v": 0
            },
            {
                "_id": "61eed26e766a16001670a08e",
                "claimProcessed": false,
                "uid": "flq1bdmr202112109121",
                "token": "l76720220113183723",
                "planType": "basic",
                "planId": "dpp04263420220113183723",
                "activationId": "ACT85319720220113184044",
                "claimId": "cla82023420220124162310",
                "createdAt": "2022-01-24T16:23:10.710Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "phone",
                "deviceBrand": "Ipad",
                "deviceModel": "gjdxkjksx",
                "uniqueDeviceNumber": "34567890987",
                "__v": 0
            },
            {
                "_id": "61df1f79559e50342ae882ce",
                "uid": "d958rc1220211222124557",
                "token": "migw2022011218308",
                "planType": "basic",
                "planId": "dpp4255802022011218308",
                "activationId": "ACT44967920220112183348",
                "claimId": "cla25784020220112183537",
                "createdAt": "2022-01-12T18:35:37.544Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "04749596",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "irfhekefrk",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61bb2919300b8cf74a093e7f",
                "uid": "flq1bdmr202112109121",
                "token": "z1co20211216101857",
                "planType": "screen_protection_plan",
                "planId": "spp40269120211216101857",
                "activationId": "ACT49067320211216113818",
                "claimId": "cla9331982021121611555",
                "createdAt": "2021-12-16T11:55:05.341Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "laptop",
                "deviceBrand": "Samsung",
                "deviceModel": "T3",
                "uniqueDeviceNumber": "2468999",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61bb28fe300b8cf74a093e69",
                "uid": "flq1bdmr202112109121",
                "token": "z1co20211216101857",
                "planType": "screen_protection_plan",
                "planId": "spp40269120211216101857",
                "activationId": "ACT59278520211216113756",
                "claimId": "cla62220720211216115438",
                "createdAt": "2021-12-16T11:54:38.159Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "phone",
                "deviceBrand": "Oppo",
                "deviceModel": "5",
                "uniqueDeviceNumber": "05567889",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ba121556de7f48c5aa7fca",
                "uid": "omxtiqxs20211215142158",
                "token": "aa2020211215143135",
                "planType": "screen_protection_plan",
                "planId": "spp69900420211215143135",
                "activationId": "ACT5577622021121515748",
                "claimId": "cla3899072021121516437",
                "createdAt": "2021-12-15T16:04:37.365Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348137501444",
                "deviceType": "phone",
                "deviceBrand": "Macbook",
                "deviceModel": "pro 13",
                "uniqueDeviceNumber": "12345678890444",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ba120c56de7f48c5aa7fbe",
                "uid": "omxtiqxs20211215142158",
                "token": "aa2020211215143135",
                "planType": "screen_protection_plan",
                "planId": "spp69900420211215143135",
                "activationId": "ACT38610220211215143550",
                "claimId": "cla7427352021121516428",
                "createdAt": "2021-12-15T16:04:28.841Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348137501444",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "12345678890444",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ab556a4b15a827977e7bd5",
                "uid": "c1guprkp202111301117",
                "token": "x8e62021113015349",
                "planType": "screen_protection_plan",
                "planId": "spp0120602021113015349",
                "activationId": "ACT7543772021124114731",
                "claimId": "cla9055252021124114754",
                "createdAt": "2021-12-04T11:47:54.607Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2349091254785",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "1234",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61a91a25a965526639bbf4d6",
                "uid": "vzj3vxt32021122183218",
                "token": "shj82021122184152",
                "planType": "screen_protection_plan",
                "planId": "spp8943932021122184152",
                "activationId": "ACT4828962021122185726",
                "claimId": "cla6478702021122191028",
                "createdAt": "2021-12-02T19:10:28.999Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "phone",
                "deviceBrand": "Tecno",
                "deviceModel": "Camon 16",
                "uniqueDeviceNumber": "354242781723200",
                "claimProcessed": false,
                "__v": 0
            }
        ]
    },
    "statusCode": 200
}
curl --request GET 'https://api.getgamp.com/v1/claim' \
--header 'Authorization: Bearer SECRET_KEY'
{
    "success": true,
    "message": "Claims Fetched Successfully",
    "data": {
        "docs": [
            {
                "_id": "61fc50e7764bd1729d84d06b",
                "claimProcessed": false,
                "uid": "vxp7uuw120211129184515",
                "token": "mjx7202112169253",
                "planType": "basic",
                "planId": "spp596363202112169253",
                "activationId": "ACT8358592021121692629",
                "claimId": "cla090494202202323214",
                "createdAt": "2022-02-03T22:02:14.466Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "laptop",
                "deviceBrand": "HP",
                "deviceModel": "Elitebook e50",
                "uniqueDeviceNumber": "jsnulmdssdklfhvjhvu36f",
                "__v": 0
            },
            {
                "_id": "61f2b04c9e113200160956ab",
                "claimProcessed": false,
                "uid": "s4j2r55v202201271459",
                "token": "9p8u2022012714628",
                "planType": "basic",
                "planId": "dpp3395282022012714628",
                "activationId": "ACT5842682022012714713",
                "claimId": "cla82163820220127144636",
                "createdAt": "2022-01-27T14:46:36.539Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348136578976",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "12",
                "uniqueDeviceNumber": "124567890",
                "__v": 0
            },
            {
                "_id": "61eed26e766a16001670a08e",
                "claimProcessed": false,
                "uid": "flq1bdmr202112109121",
                "token": "l76720220113183723",
                "planType": "basic",
                "planId": "dpp04263420220113183723",
                "activationId": "ACT85319720220113184044",
                "claimId": "cla82023420220124162310",
                "createdAt": "2022-01-24T16:23:10.710Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "phone",
                "deviceBrand": "Ipad",
                "deviceModel": "gjdxkjksx",
                "uniqueDeviceNumber": "34567890987",
                "__v": 0
            },
            {
                "_id": "61df1f79559e50342ae882ce",
                "uid": "d958rc1220211222124557",
                "token": "migw2022011218308",
                "planType": "basic",
                "planId": "dpp4255802022011218308",
                "activationId": "ACT44967920220112183348",
                "claimId": "cla25784020220112183537",
                "createdAt": "2022-01-12T18:35:37.544Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "04749596",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "irfhekefrk",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61bb2919300b8cf74a093e7f",
                "uid": "flq1bdmr202112109121",
                "token": "z1co20211216101857",
                "planType": "screen_protection_plan",
                "planId": "spp40269120211216101857",
                "activationId": "ACT49067320211216113818",
                "claimId": "cla9331982021121611555",
                "createdAt": "2021-12-16T11:55:05.341Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "laptop",
                "deviceBrand": "Samsung",
                "deviceModel": "T3",
                "uniqueDeviceNumber": "2468999",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61bb28fe300b8cf74a093e69",
                "uid": "flq1bdmr202112109121",
                "token": "z1co20211216101857",
                "planType": "screen_protection_plan",
                "planId": "spp40269120211216101857",
                "activationId": "ACT59278520211216113756",
                "claimId": "cla62220720211216115438",
                "createdAt": "2021-12-16T11:54:38.159Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348166503967",
                "deviceType": "phone",
                "deviceBrand": "Oppo",
                "deviceModel": "5",
                "uniqueDeviceNumber": "05567889",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ba121556de7f48c5aa7fca",
                "uid": "omxtiqxs20211215142158",
                "token": "aa2020211215143135",
                "planType": "screen_protection_plan",
                "planId": "spp69900420211215143135",
                "activationId": "ACT5577622021121515748",
                "claimId": "cla3899072021121516437",
                "createdAt": "2021-12-15T16:04:37.365Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348137501444",
                "deviceType": "phone",
                "deviceBrand": "Macbook",
                "deviceModel": "pro 13",
                "uniqueDeviceNumber": "12345678890444",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ba120c56de7f48c5aa7fbe",
                "uid": "omxtiqxs20211215142158",
                "token": "aa2020211215143135",
                "planType": "screen_protection_plan",
                "planId": "spp69900420211215143135",
                "activationId": "ACT38610220211215143550",
                "claimId": "cla7427352021121516428",
                "createdAt": "2021-12-15T16:04:28.841Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2348137501444",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "12345678890444",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61ab556a4b15a827977e7bd5",
                "uid": "c1guprkp202111301117",
                "token": "x8e62021113015349",
                "planType": "screen_protection_plan",
                "planId": "spp0120602021113015349",
                "activationId": "ACT7543772021124114731",
                "claimId": "cla9055252021124114754",
                "createdAt": "2021-12-04T11:47:54.607Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "2349091254785",
                "deviceType": "phone",
                "deviceBrand": "Iphone",
                "deviceModel": "x",
                "uniqueDeviceNumber": "1234",
                "claimProcessed": false,
                "__v": 0
            },
            {
                "_id": "61a91a25a965526639bbf4d6",
                "uid": "vzj3vxt32021122183218",
                "token": "shj82021122184152",
                "planType": "screen_protection_plan",
                "planId": "spp8943932021122184152",
                "activationId": "ACT4828962021122185726",
                "claimId": "cla6478702021122191028",
                "createdAt": "2021-12-02T19:10:28.999Z",
                "status": "pending",
                "statusNo": "1",
                "contact": "",
                "deviceType": "phone",
                "deviceBrand": "Tecno",
                "deviceModel": "Camon 16",
                "uniqueDeviceNumber": "354242781723200",
                "claimProcessed": false,
                "__v": 0
            }
        ]
    },
    "statusCode": 200
}
PreviousProtected Devices πŸ“±NextRepairs πŸ› οΈ

Last updated 2 months ago