Benefits
Benefits are returned as part of a policy, rather than through a separate Benefits endpoint. Request policies from the Policies API and read each policy's benefits array.
Benefit properties
Each benefit includes a code, name, category, and description.
- Name
benefit_code- Type
- string
- Description
Identifier for the benefit.
- Name
name- Type
- string
- Description
The benefit name.
- Name
category- Type
- string
- Description
The benefit category supplied with the policy data.
- Name
description- Type
- string
- Description
Details describing the benefit and its terms.
GET/v1/policies
Retrieve policy benefits
Request a policy using its policy_id. Benefit details are included in the policy response under benefits. Financial details such as annual_max_benefit are included when available for that policy.
Request
GET
/v1/policies/taka_000002bzcurl https://api.insuredspeaks.com/v1/policies/taka_000002bz \
-H "Authorization: Bearer {token}"
Response
{
"success": true,
"data": {
"policy_id": "taka_000002bz",
"limits": {
"annual_max_benefit": 100000,
"currency": "MYR"
},
"benefits": [
{
"benefit_code": "benefit_example_1",
"name": "Death Benefit",
"category": "Death or total and permanent disability (TPD)",
"description": "Provides a lump sum payment if the participant passes away during the coverage term."
}
]
}
}
GET/v1/policies
List policies and their benefits
Use the list endpoint to retrieve a paginated set of policies. Each result includes its own benefits array.
curl "https://api.insuredspeaks.com/v1/policies?page=1&limit=20" \
-H "Authorization: Bearer {token}"
For policy fields and filters, see the Policies documentation.