Skip to main content
POST
/
api
/
v1
/
claims
curl --request POST \
  --url https://dev.superpool.unyte.africa/api/v1/claims/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "claimant_metadata": {
    "first_name": "John",
    "last_name": "Doe",
    "birth_date": "1985-05-15",
    "email": "[email protected]",
    "relationship": "Self"
  },
  "claim_details": {
    "claim_type": "accident",
    "incident_description": "Car accident on highway",
    "incident_date": "2024-07-10",
    "claim_amount": "1500.00",
    "supporting_documents": [
      {
        "document_name": "Police Report",
        "evidence_type": "PDF",
        "document_url": "https://example.com/police-report.pdf",
        "uploaded_at": "2024-07-11T08:00:00Z"
      }
    ]
  },
  "policy_id": "123e4567-e89b-12d3-a456-426614174000",
  "witness_details": [],
  "authority_report": {
    "report_number": "ABC123456",
    "report_date": "2024-07-11",
    "filing_station": "Miami Police Station"
  }
}
'
{
  "claim_id": "d2d0c0b4-bf72-4a61-a02e-3ab896dd8bf7",
  "claim_reference_number": "CLAIM-20240813-5678",
  "claim_status": "submitted",
  "insurer": "Leadway Assurance"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
U-Request-Id
string

Idempotency key to enforce idempotent processing of POST requests

Path Parameters

​
id
string
required

UUID of the claim

Body

Validates incoming request data for creating a new claim.

​
claimant_metadata
object
required

Validates incoming request data for creating a new claim.

​
claim_details
object
required

Specifies the data structure for capturing claim details

​
policy_id
string<uuid>
​
policy_number
string
​
witness_details
object[]
​
authority_report
object

Specifies the data structure for the Authority Report e.g Police Report

Response

201 - application/json

Claim submitted successfully

V2 Serializer for formating responses when

​
claim_id
string<uuid>
required
​
policy_id
string
required
​
claim_status
string
required
​
insurer
string
required