Retrieve a claim by its ID or Reference Number
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/claims/{id}/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://dev.superpool.unyte.africa/api/v1/claims/{id}/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://dev.superpool.unyte.africa/api/v1/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.superpool.unyte.africa/api/v1/claims/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.superpool.unyte.africa/api/v1/claims/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.superpool.unyte.africa/api/v1/claims/{id}/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/claims/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"claim_id": "d2d0c0b4-bf72-4a61-a02e-3ab896dd8bf7",
"claim_reference_number": "CLAIM-20240813-5678",
"claim_status": "approved",
"claim_date": "2024-08-13",
"claimant": {
"customer_id": "71e1d8b4-c26b-4014-afcb-6f94a8adac1a",
"customer_name": "Michael Smith",
"customer_email": "michaelsmith@example.com",
"customer_phone": "+9876543210"
},
"claim_amount": "3200.00",
"insurer": "Leadway Assurance",
"product": {
"name": "Auto Insurance",
"product_type": "Automobile"
},
"policy": "dc4bf271-6491-3812-8f39-58d4ccf39b70",
"claim_status_timeline": [
{
"time_stamp": "2024-08-13 08:45:00",
"name": "submitted"
},
{
"time_stamp": "2024-08-13 10:00:00",
"name": "under review"
},
{
"time_stamp": "2024-08-13 12:15:00",
"name": "pending approval"
},
{
"time_stamp": "2024-08-13 14:30:00",
"name": "approved"
}
],
"notes": "Claim approved and payment initiated.",
"documents": [
{
"document_name": "Claim Form",
"evidence_type": "PDF",
"blob": "base64encodedstring",
"uploaded_at": "2024-08-13T08:00:00Z"
},
{
"document_name": "Medical Report",
"evidence_type": "PDF",
"blob": "base64encodedstring",
"uploaded_at": "2024-08-13T08:30:00Z"
}
]
}Claims
Retrieve a claim by its ID or Reference Number
Retrieve a single claim by its unique ID or claim reference number
GET
/
api
/
v1
/
claims
/
{id}
/
Retrieve a claim by its ID or Reference Number
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/claims/{id}/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://dev.superpool.unyte.africa/api/v1/claims/{id}/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://dev.superpool.unyte.africa/api/v1/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.superpool.unyte.africa/api/v1/claims/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.superpool.unyte.africa/api/v1/claims/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.superpool.unyte.africa/api/v1/claims/{id}/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/claims/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"claim_id": "d2d0c0b4-bf72-4a61-a02e-3ab896dd8bf7",
"claim_reference_number": "CLAIM-20240813-5678",
"claim_status": "approved",
"claim_date": "2024-08-13",
"claimant": {
"customer_id": "71e1d8b4-c26b-4014-afcb-6f94a8adac1a",
"customer_name": "Michael Smith",
"customer_email": "michaelsmith@example.com",
"customer_phone": "+9876543210"
},
"claim_amount": "3200.00",
"insurer": "Leadway Assurance",
"product": {
"name": "Auto Insurance",
"product_type": "Automobile"
},
"policy": "dc4bf271-6491-3812-8f39-58d4ccf39b70",
"claim_status_timeline": [
{
"time_stamp": "2024-08-13 08:45:00",
"name": "submitted"
},
{
"time_stamp": "2024-08-13 10:00:00",
"name": "under review"
},
{
"time_stamp": "2024-08-13 12:15:00",
"name": "pending approval"
},
{
"time_stamp": "2024-08-13 14:30:00",
"name": "approved"
}
],
"notes": "Claim approved and payment initiated.",
"documents": [
{
"document_name": "Claim Form",
"evidence_type": "PDF",
"blob": "base64encodedstring",
"uploaded_at": "2024-08-13T08:00:00Z"
},
{
"document_name": "Medical Report",
"evidence_type": "PDF",
"blob": "base64encodedstring",
"uploaded_at": "2024-08-13T08:30:00Z"
}
]
}Authorizations
Path Parameters
UUID of the claim
Response
Serializer for Claim instances.
This serializer includes fields that are intended to be visible when retrieving or listing Claim objects. It provides a human-readable representation of the Claim, including status descriptions.
Pattern:
^-?\d{0,8}(?:\.\d{0,2})?$Pattern:
^-?\d{0,8}(?:\.\d{0,2})?$Serilizes the metadata about the product category a claim belongs to
Show child attributes
Show child attributes
Unique identifier for the policy
Show child attributes
Show child attributes
Pattern:
^-?\d{0,8}(?:\.\d{0,2})?$⌘I
