Get a covered household by the principal's NRC number
GET
/group-funeral/members/by-nrc
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
nrcNumber
Type
string
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "intermediaryId": 0, "userId": 0, "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "campId": { }, "camp": { } } ], "firstName": "string", "middleName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "fullName": "string", "maritalStatus": "string" }, "policyId": "string", "policy": { "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "intermediaryId": 0, "userId": 0, "farms": [ { } ] }, "policyNumber": "string", "status": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "partnerId": 0, "partner": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "email": "string", "apiKey": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "apiUser": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "apiUserId": 0, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "paymentMethod": [ { } ], "paymentMethods": [ { } ], "smsOriginatorId": "string", "type": "string", "status": "string", "category": "string", "partnerSelfServiceApiKey": "string", "paymentCallbackUrl": "string", "paymentGateways": [ { } ], "insurerApiConfigs": [ { } ] }, "insurerId": "string", "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "taxPayerId": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "popularity": 0, "insurerType": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "status": "string", "shortName": "string" }, "productId": "string", "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "classOfBusinessId": "string", "classOfBusiness": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "order": { }, "products": { } }, "insurerId": "string", "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "productCategoryId": 0, "productCategory": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "isActive": { }, "createdById": { }, "createdBy": { }, "classOfBusinessId": { }, "classOfBusiness": { }, "products": { } }, "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "status": "string", "documents": [ { } ], "distributionChannels": [ { } ], "paymentMethods": [ { } ], "discounts": [ { } ], "intermediaryCommissionRates": [ { } ], "premiumLimits": [ { } ], "codeRules": [ { } ] }, "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "currency": "string", "exchangeRate": 0, "sourceOfBusiness": { "id": "string", "createdAt": "string", "updatedAt": "string", "type": "string", "intermediaryId": 0, "partnerId": 0, "platform": "string" }, "sourceOfBusinessId": "string", "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "extensionsPremium": 0, "discountsPremium": 0, "intermediaryId": 0, "intermediary": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "logoUrl": "string", "taxPayerId": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "status": "string", "mergedIntoId": 0, "type": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "smsOriginatorId": "string", "systemPermissions": [ { } ], "insurerIntermediaryBranches": [ { } ], "insurerApiConfigs": [ { } ], "districtId": 0, "district": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "level": { }, "parentId": { }, "parent": { }, "children": { }, "province": { }, "provinceId": { } }, "insurerCodes": [ { } ] }, "branch": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "insurerId": 0, "intermediaryId": 0, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } } }, "branchId": 0, "paymentPlanId": 0, "paymentPlan": { "id": "string", "createdAt": "string", "updatedAt": "string", "referenceNumber": "string", "description": "string", "startDate": "string", "totalAmount": 0, "firstInstallmentDate": "string", "numberOfInstallments": 0, "frequency": "string", "amountType": "string", "status": "string", "currency": "string", "outstandingBalance": 0, "paidAmount": 0, "clientId": "string", "client": { "id": { }, "createdAt": { }, "updatedAt": { }, "email": { }, "taxPayerId": { }, "bankDetail": { }, "phoneNumber": { }, "physicalAddress": { }, "insurerId": { }, "partnerId": { }, "type": { }, "status": { }, "dateOfBirth": { }, "createdById": { }, "createdBy": { }, "intermediaryId": { }, "userId": { }, "farms": { } }, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "insurerId": 0, "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "intermediaryId": 0, "intermediary": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "logoUrl": { }, "taxPayerId": { }, "email": { }, "address": { }, "bankDetail": { }, "status": { }, "mergedIntoId": { }, "type": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "smsOriginatorId": { }, "systemPermissions": { }, "insurerIntermediaryBranches": { }, "insurerApiConfigs": { }, "districtId": { }, "district": { }, "insurerCodes": { } }, "policyId": "string", "policy": { "id": { }, "createdAt": { }, "updatedAt": { }, "clientId": { }, "client": { }, "policyNumber": { }, "status": { }, "approvedDate": { }, "startDate": { }, "endDate": { }, "partnerId": { }, "partner": { }, "insurerId": { }, "insurer": { }, "productId": { }, "product": { }, "createdById": { }, "createdBy": { }, "currency": { }, "exchangeRate": { }, "sourceOfBusiness": { }, "sourceOfBusinessId": { }, "premiumLevy": { }, "basicPremium": { }, "grossPremium": { }, "extensionsPremium": { }, "discountsPremium": { }, "intermediaryId": { }, "intermediary": { }, "branch": { }, "branchId": { }, "paymentPlanId": { }, "paymentPlan": { }, "cancellationType": { }, "premiumStatus": { }, "beneficiaryPolicies": { } }, "paymentPlanConfigId": 0, "paymentPlanConfig": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "status": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "createdById": { }, "createdBy": { }, "productAssignments": { }, "intermediaryAssignments": { }, "partnerAssignments": { } }, "invoices": [ { } ], "approvedBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "approvedById": 0, "approvedAt": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "transactions": [ { } ], "isDeleted": true, "deletedAt": "string", "deletedById": 0, "configSnapshot": { "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "snapshotTakenAt": { } }, "modeOfPayment": "string" }, "cancellationType": "string", "premiumStatus": "string", "beneficiaryPolicies": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "beneficiaryId": { }, "beneficiary": { }, "policyId": { } } ], "name": "string", "claimNotificationDays": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "customRate": 0, "load": 0, "childMaximumAge": 0, "ageBands": [ { "fromAge": { }, "toAge": { }, "rate": { } } ], "benefits": [ { "benefitType": { }, "sumAssured": { } } ], "quotationId": "string", "quotation": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "insurerId": "string", "intermediaryId": 0, "corporateClient": "string", "insurer": "string", "intermediary": "string", "product": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "productId": "string", "selectedScopeOfCoverIds": [ { } ], "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "claimNotificationDays": 0, "status": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "customRate": 0, "load": 0, "childMaximumAge": 0, "benefits": [ { } ], "ageBands": [ { } ] }, "members": [ { } ] }, "scheduleId": "string", "ageNextBirthday": 0, "sumAssured": 0, "appliedRate": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "daysProRata": 0, "status": "string", "beneficiaries": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupFuneralMemberId": "string", "fullName": "string", "relationship": "string", "dateOfBirth": "string", "ageNextBirthday": 0, "sumAssured": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "status": "string" } ]
{
}