NAICOM Portal API
v0/v1
3rd Edition
TTC Technologies, Inc.
Date: Feb. 13, 2021
Updated May 10 2021
Contents
2.1 Basic Schema an Insurance
Policy Data
2.2 Sample Insurance Policy Data
2.2.1 Sample “Auto” Insurance Policy Data
2.2.2 Sample “Bond” Insurance Policy Data
2.2.4 Sample “Engineer” Policy Data
2.2.5 Sample “Fire” Insurance Policy Data
2.2.6 Sample “Marine” Insurance Policy Data
2.2.7 Sample “Oil” Insurance Policy Data
2.2.8 Sample “Individual Life” Insurance Policy
Data
2.2.9 Sample “Group Life” Insurance Policy Data
2.2.10 Sample “Miscellaneous” Insurance Policy Data
2.3 Attributes of Insurance
Policy Data
2.3.1 Attributes in “Basic Info” Data Group
2.3.2 Attributes for “Auto” Insurance Policy Data
2.3.2.1 Attributes in “Detail Info” Data Group
2.3.2.2 Attributes in “Insured Info” Data Group
2.3.3 Attributes for “Bond” Insurance Policy Data
2.3.3.1 Attributes in “Detail Info” Data Group
2.3.4 Attributes for “Casualty” Insurance Policy
Data
2.3.4.1 Attributes in “Detail Info” Data Group
2.3.5 Attributes for “Engineer” Insurance Policy
Data
2.3.5.1 Attributes in “Detail Info” Data Group
2.3.6 Attributes for “Fire” Insurance Policy Data
2.3.6.1 Attributes in “Detail Info” Data Group
2.3.7 Attributes for “Marine” Insurance Policy
Data
2.3.7.1 Attributes in “Detail Info” Data Group
2.3.7.2 Attributes in “Insured Info” Data Group
2.3.8 Attributes for “Oil” Insurance Policy Data
2.3.8.1 Attributes in “Detail Info” Data Group
2.3.9 Attributes for “Life Individual” Insurance
Policy Data
2.3.9.1 Attributes in “Detail Info” Data Group
2.3.9.2 Attributes in “Insured Info” Data Group
2.3.10 Attributes for “Life Group” Insurance Policy
Data
2.3.10.1 Attributes in “Detail Info” Data Group
2.3.10.2 Attributes in “Insured Info” Data Group
2.3.11 Attributes for “Misc” Insurance Policy Data
2.3.11.1 Attributes in “Detail Info” Data Group
3.2 Check Supported API Versions
4.1 Verify Authentication Token
5.3 Sample Detailed Query Data
5.3.1 Sample
Query Data for “Auto” Policy
5.3.2 Sample
Query Data for “Bond” Policy
5.3.3 Sample
Query Data for “Casualty” Policy
5.3.4 Sample
Query Data for “Engineer” Policy
5.3.5 Sample
Query Data for “Fire” Policy
5.3.6 Sample
Query Data for “Marine” Policy
5.3.7 Sample
Query Data for “Oil” Policy
5.3.8 Sample
Query Data for “Individual Life” Policy
5.3.9 Sample
Query Data for “Group Life” Policy
5.3.10 Sample
Query Data for “Miscellaneous” Policy
6.1 Record a “Auto” Insurance Policy Data..
6.2 Record a “Bond” Insurance Policy Data..
6.3 Record a “Casualty” Insurance Policy Data
6.4 Record a “Engineer” Insurance Policy Data
6.5 Record a “Fire” Insurance Policy Data..
6.6 Record a “Marine” Insurance Policy Data
6.7 Record a “Oil” Insurance Policy Data..
6.8 Record a “Individual Life” Insurance Policy Data
6.9 Record a “Group Life” Insurance Policy Data
6.10 Record a “Miscellaneous” Insurance Policy Data
7.1 Revise a “Auto” Insurance Policy Data..
7.2 Revise a “Bond” Insurance Policy Data..
7.3 Revise a “Casualty” Insurance Policy Data
7.4 Revise a “Engineer” Insurance Policy Data
7.5 Revise a “Fire” Insurance Policy Data..
7.6 Revise a “Marine” Insurance Policy Data
7.7 Revise a “Oil” Insurance Policy Data..
7.8 Revise a “Individual Life” Insurance Policy Data
7.9 Revise a “Group Life” Insurance Policy Data
7.9.1
Revise a “Group Life” Insurance Policy Data - Endorsement
7.10 Revise a “Miscellaneous” Insurance Policy Data
9. Policy
Termination or Deletion API
9.1 Terminate an Insurance Policy
9.2 Delete an Insurance Policy
10. Recording
CoInsurance Policies
10.1 Record Coinsurance Insurance
Policy Percentages
10.2 Confirm a Coinsurance Policy
10.3 Update a Recorded
Coinsurance Insurance Policy Percentages
10.4 Check the Status of a
Coinsured Policy
10.5 Check the Status of all
Coinsured Policies for a Company
10.6 Check the Status of
Unconfirmed Coinsured Policies for a Company.
10.7 Check the Status of
Partially Confirmed Coinsured Policies for a Company
10.8 Check the Status of Fully
Confirmed Coinsured Policies for a Company
10.9 Check the Status of Fully
Confirmed Coinsured Policies for a Secondary Company
10.10 Check the Status of
UnConfirmed Coinsured Policies for a Secondary Company
12.1 Insurance Category, Class,
and Type
In this API, RESTful https
calls are provided to execute fundamental NAICOM Portal tasks.
In this manual, both the v0
and v1 versions will be introduced:
The current base access point
for the RESTful API on the test portal is
https://testportal.naicom.gov.ng:8443/api/
In this manual, examples will
be given for both the v0 and v1 version of the API calls
The basic schema of a policy
data is shown as the follows
|
{ "PolicyID":
"…", "PolicyUniqueID":
"…", "DataGroup":
[ { "GroupName": "Basic Info",
"GroupTag": 0, "GroupCount": 0, "AttArray": [ { "Name": "…", "Value": "…" }, … ] } { "GroupName": "Detail Info",
"GroupTag": 1, "GroupCount": 0, "AttArray": [ { "Name": "…", "Value": "…" }, … ] } { "GroupName": "Insured Info",
"GroupTag": 2, "GroupCount": 0, "AttArray": [ { "Name": "…", "Value": "…" }, … ] } … ] } |
Note that
·
An insurance
policy data includes
o
"PolicyID"
– the NAICOM internal policy ID
o
"PolicyUniqueID"
– the Unique Policy ID issued by NAICOM
o
"DataGroup"
– a policy data must contain three kinds of "DataGroup"
v "Basic Info" data group
ü It contains the basic information about a policy.
ü One insurance policy can only contain one "Basic
Info" data group.
ü It contains the common attributes for all kinds of
insurance.
ü "GroupTag" must be "0".
ü "GroupCount" must be "0".
v "Detail Info" data group
ü It contains the specific information about a certain
kind of policy.
ü One insurance policy can only contain one "Detail
Info" data group.
ü It contains different attributes for different kinds
of insurance.
ü "GroupTag" must be "1".
ü "GroupCount" must be "0".
v "Insured Info" data group
ü It contains the information of the insured item(s).
ü Based on different kinds of policy, the policy data
may contains zero, one, or more
"Insured Info" data group
ü It contains different attributes for different kinds
of insurance.
ü "GroupTag" must be "2".
ü For the first insured item, "GroupCount"
must be "0". For the second insured item, "GroupCount" must
be "1", and so on.
ü Only certain kinds of insurance policy requires
insured item(s).
A sample auto insurance
policy data in JSON format is given below:
|
{ "PolicyID": "fa8be69a-4cfd-40dd-ad35-18759dd6d808", "PolicyUniqueID": "052101000000022", "DataGroup": [ { "GroupName": "Basic Info", "GroupTag": 0, "GroupCount": 0, "AttArray": [ { "Name": "UniquePolicyID", "Value": "052101000000022" }, { "Name": "Insurer", "Value": "AIICO Insurance PLC" }, { "Name": "Product", "Value": "General : Motor : Private Vehicle Individual" }, { "Name": "RecorderType", "Value": "Company" }, { "Name": "Recorder", "Value": "AIICO Insurance PLC (RIC:004)" }, { "Name": "RecorderID", "Value": "5" }, { "Name": "ProductID", "Value": "151" }, { "Name": "TypeID", "Value": "1" }, { "Name": "ClassID", "Value": "1" }, { "Name": "CategoryID", "Value": "1" }, { "Name": "CoverageStartDate", "Value": "July 04, 2020" }, { "Name": "CoverageEndDate", "Value": "July 03, 2021" }, { "Name": "PolicyInternalID", "Value": "aiico1201" }, { "Name": "PolicyDescription", "Value": "n/a" }, { "Name": "Status", "Value": "Active" }, { "Name": "DetailType", "Value": "Auto" }, { "Name": "InsuredType", "Value": "Auto" } ] }, { "GroupName": "Detail Info", "GroupTag": 1, "GroupCount": 0, "AttArray": [ { "Name": "CoverageType", "Value": "THIRD_PARTY" }, { "Name": "OwnerType", "Value": "PERSON" }, { "Name": "OwnerLicense", "Value": "abcdefg" }, { "Name": "PersonNameLast", "Value": "Nico" }, { "Name": "PersonNameFirst", "Value": "Sam" }, { "Name": "AddressLine", "Value": "120 New Moriches Rd" }, { "Name": "CityLGA", "Value": "Lake Grove" }, { "Name": "State", "Value": "Abia" }, { "Name": "PostCode", "Value": "11755" }, { "Name": "Phone", "Value": "364889477" }, { "Name": "Email", "Value": "test@test.com" }, { "Name": "InsuredValue", "Value": "500000" }, { "Name": "Premium", "Value": "50000" }, { "Name": "CommissionFee", "Value": "500" }, { "Name": "ExtraFee", "Value": "0" }, { "Name": "PremiumNote", "Value": "n/a" }, { "Name": "Terms", "Value": "n/a" }, { "Name": "Preamble", "Value": "n/a" }, { "Name": "Endorsements", "Value": "n/a" }, { "Name": "Exclusions", "Value": "n/a" }, { "Name": "Exceptions", "Value": "n/a" }, { "Name": "Conditions", "Value": "n/a" } ] }, { "GroupName": "Insured Info", "GroupTag": 2, "GroupCount": 0, "AttArray": [ { "Name": "InsuredNo", "Value": "1" }, { "Name": "VehicleID", "Value": "VIN12345678" }, { "Name": "PlateNo", "Value": "NEW-YORK-001" }, { "Name": "RegNo", "Value": "REG00000001" }, { "Name": "RegDate", "Value": "July 04, 2020" }, { "Name": "RegExpDate", "Value": "July 04, 2022" }, { "Name": "RegMileage", "Value": "100000" }, { "Name": "AutoType", "Value": "CAR" }, { "Name": "AutoMake", "Value": "Ford" }, { "Name": "AutoModel", "Value": "Escort" }, { "Name": "AutoColor", "Value": "Black" }, { "Name": "AutoYear", "Value": "2018" }, { "Name": "EngineCap", "Value": "2.5" }, { "Name": "SeatCap", "Value": "5" }, { "Name": "AutoNote", "Value": "n/a" } ] }, { "GroupName": "Insured Info", "GroupTag": 2, "GroupCount": 1, "AttArray": [ { "Name": "InsuredNo", "Value": "2" }, { "Name": "VehicleID", "Value": "VIN4646464" }, { "Name": "PlateNo", "Value": "NEW-YORK-002" }, { "Name": "RegNo", "Value": "REG00000002" }, { "Name": "RegDate", "Value": "July 04, 2020" }, { "Name": "RegExpDate", "Value": "July 04, 2022" }, { "Name": "RegMileage", "Value": "100000" }, { "Name": "AutoType", "Value": "CAR" }, { "Name": "AutoMake", "Value": "Honda" }, { "Name": "AutoModel", "Value": "Accord" }, { "Name": "AutoColor", "Value": "White" }, { "Name": "AutoYear", "Value": "2016" }, { "Name": "EngineCap", "Value": "2.6" }, { "Name": "SeatCap", "Value": "8" }, { "Name": "AutoNote", "Value": "n/a" } ] } ], } |
A sample bond insurance
policy data in JSON format is given below:
|
{ "PolicyID": "e6ad3e73-7355-4216-a9b4-a08425519993", "PolicyUniqueID": "052109000000023", "DataGroup": [ { "GroupName": "Basic Info", "GroupTag": 0, "GroupCount": 0, "AttArray": [ { "Name": "UniquePolicyID", "Value": "052109000000023" }, { "Name": "Insurer", "Value": "AIICO Insurance PLC" }, { "Name": "Product", "Value": "General : Bond & Credit : Advance Payment Bond" }, { "Name": "RecorderType", "Value": "Company" }, { "Name": "Recorder", "Value": "AIICO Insurance PLC (RIC:004)" }, { "Name": "RecorderID", "Value": "5" }, { "Name": "ProductID", "Value": "152" }, { "Name": "TypeID", "Value": "9" }, { "Name": "ClassID", "Value": "2" }, { "Name": "CategoryID", "Value": "1" }, { "Name": "CoverageStartDate", "Value": "July 04, 2020" }, { "Name": "CoverageEndDate", "Value": "July 03, 2021" }, { "Name": "PolicyInternalID", "Value": "aiico1202" }, { "Name": "PolicyDescription", "Value": "n/a" }, { "Name": "Status", "Value": "Active" }, { "Name": "DetailType", "Value": "Bond" }, { "Name": "InsuredType", "Value": "Bond" } ] }, { "GroupName": "Detail Info", "GroupTag": 1, "GroupCount": 0, "AttArray": [ { "Name": "BeneficiaryType", "Value": "INDIVIDUAL" }, { "Name": "PersonNameLast", "Value": "Tom" }, { "Name": "PersonNameFirst", "Value": "Lung" }, { "Name": "PersonIDDoc", "Value": "NATIONAL_ID_CARD" }, { "Name": "PersonIDNo", "Value": "123364656565" }, { "Name": "AddressLine", "Value": "120 New Moriches Rd" }, { "Name": "CityLGA", "Value": "City" }, { "Name": "State", "Value": "Abia" }, { "Name": "PostCode", "Value": "11755" }, { "Name": "Phone",
|