Get Endorsement

Retrieve the details of a single endorsement record by its ID.

Endpoint

GET /v1/policy/endorsements/{endorsement_id}

Path Parameters

Parameter	Description
endorsement_id	BizzAssure internal endorsement ID (from endorsement_ids in Create Endorsement)

Request

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Example Request

GET /v1/policy/endorsements/ba_end_01k...
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

Success (200 OK)

{
  "payload": {
    "endorsement": {
      "id": "ba_end_01k...",
      "client_id": "ba_client_abc...",
      "policy_id": "ba_pol_01k...",
      "employee_id": "ba_emp_01jwz3k...",
      "type": "ENDORSEMENT_TYPE_ADDITION",
      "status": "ENDORSEMENT_STATUS_APPROVED",
      "coverage_start_date": "2024-07-01",
      "coverage_end_date": "2024-07-31",
      "premium_impact": 12000.0,
      "sum_insured": 300000,
      "rejection_reason": null
    },
    "message": "Endorsement retrieved successfully",
    "success": true
  }
}

Endorsement Object Fields

Field	Type	Description
id	string	BizzAssure internal endorsement ID
client_id	string	Client/organisation this endorsement belongs to
policy_id	string	Policy this endorsement is against
employee_id	string	BizzAssure internal employee ID
type	string	ENDORSEMENT_TYPE_ADDITION or ENDORSEMENT_TYPE_DELETION
status	string	Current status (see lifecycle table below)
coverage_start_date	string	Coverage start date (YYYY-MM-DD)
coverage_end_date	string	Coverage end date (YYYY-MM-DD)
premium_impact	number	Premium change resulting from this endorsement (INR)
sum_insured	number	Sum insured for this member (INR)
rejection_reason	string?	Reason for rejection — populated only when status is ENDORSEMENT_STATUS_REJECTED

Endorsement Lifecycle

Status	Description
ENDORSEMENT_STATUS_PENDING	Workflow started, awaiting review
ENDORSEMENT_STATUS_SENT_TO_INSURER	Submitted to the insurer for processing
ENDORSEMENT_STATUS_APPROVED	Approved by the insurer — coverage active
ENDORSEMENT_STATUS_REJECTED	Rejected by the insurer
ENDORSEMENT_STATUS_CANCELLED	Cancelled

Error Responses

Not Found (404)

{
  "type": "NOT_FOUND",
  "title": "Endorsement Not Found",
  "detail": "No endorsement found with the given ID",
  "instance": "/v1/policy/endorsements/ba_end_01k"
}

Unauthorized (401)

{
  "type": "UNAUTHORIZED",
  "title": "Unauthorized",
  "detail": "Missing or invalid access token",
  "instance": "/v1/policy/endorsements/ba_end_01k"
}