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

Make a Claim

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

Create a new plan

Headers

NameTypeDescription

authorization*

String

Set value to Bearer SECRET_KEY

Request Body

NameTypeDescription

activationId*

String

The activationId 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
}
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"
}'

Fetch Claims

Fetch Claim

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

Fetch a plan

Path Parameters

NameTypeDescription

deviceId*

String

The deviceID linked to the plan

Headers

NameTypeDescription

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
}
curl --request GET 'https://api.getgamp.com/v1/claim/dev8358592021121692629' \
--header 'Authorization: Bearer SECRET_KEY'

List Claims

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

Fetch a list of claims

Query Parameters

NameTypeDescription

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

NameTypeDescription

Authorization*

String

Set value to Bearer SECRET_KEY

{
    "statusCode": 401,
    "message": "Unauthorized"
}
curl --request GET 'https://api.getgamp.com/v1/claim' \
--header 'Authorization: Bearer SECRET_KEY'

Last updated