Skip to content

Enrol a batch of members

POST
/group-life/policies/{policyId}/members

Straight-through: uploaded and approved in one call, which puts the members on risk. Approval does NOT collect money — the premium becomes due and is receipted separately as you remit, so cover starts while premium is still owed and outstandingPremium says how much. Approved, PartiallyReceipted or Receipted means covered; Pending means the batch was not approved and they are NOT covered. Set midTermAddition for a batch joining a policy already running — those members are pro-rated to the remaining period.

Authorizations

BearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

policyId*
Type
string
Required

Request Body

application/json
JSON
{
  
"members": [
  
  
{
  
  
  
"fullName": "string",
  
  
  
"nrcNumber": "string",
  
  
  
"dateOfBirth": "string",
  
  
  
"annualSalary": 0
  
  
}
  
],
  
"currency": "string",
  
"exchangeRate": 0,
  
"midTermAddition": true
}

Responses

Success

application/json
JSON
{
  
"id": "string",
  
"number": "string",
  
"status": "string",
  
"type": "string",
  
"totalMembers": 0,
  
"netPremium": 0,
  
"levy": 0,
  
"grossPremium": 0,
  
"amountReceipted": 0,
  
"outstandingPremium": 0,
  
"currency": "string",
  
"createdAt": "string"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Built with ❤️ by Hobbiton Technologies