0% found this document useful (0 votes)
22 views

HIIB Website API Integration V1.7

Uploaded by

Tarun Yadav
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
22 views

HIIB Website API Integration V1.7

Uploaded by

Tarun Yadav
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 52

Implementation Approach

Website API Integration


Version 1.7

Hyundai India Insurance


Broking Pvt Ltd (HIIB)

05 April 2024
Contents

Introduction ................................................................................................................................... 2

Functional Exposure by HIIB


2

Function/ API Signature


2

User Prerequisites for Token Authentication Mechanism ......................................................... 3


A: Parameters Required ................................................................................................................................. 17
B: Instructions Required .................................................................................................................................. 17
Type – POST ...................................................................................................................................................... 17
Type – GET ........................................................................................................................................................ 17

Integration Steps to generate access token for consumption of API


..................................................................................................................................................... 21

FAQ’s
..................................................................................................................................................... 51

I Implementation Approach Website API Integration i


Introduction
● This document describes the approach to integrate APIs for HIIB website along with Cognito Token
Authentication.
● As per the IRDA guidelines, an authentication mechanism must be in place when invoking web
Services/ APIs.

Functional Exposure by HIIB


HIIB will expose functions to communicate through API. HIIB will expose different methods for different
actions which will be consumed by user.

Function/ API Signature


1. Get OTP:
 OTP Generation API (Exposed by HIIB)
 HIIB is exposing the function, named GetOTP. This function will accept 5 parameters and return
status of the action.
 The details of the input and output parameters of function GetOTP are mentioned in tables
below:
Input Parameters
Column Name Description DataType Length Mandatory
RegistrationNo Registration No is mandatory if Policy string Conditional
No is not filled. (Alphanumeric only)
PolicyNo Policy No is mandatory if Registration string Conditional
No not filled.
MobileNo Mobile No is mandatory if Engine No string Conditional
and Chassis No not filled (Numeric
Only)
EngineNo Engine No is mandatory if Mobile No string Conditional
and Chassis No not filled
(Alphanumeric only)
ChassisNo Chassis No is mandatory if Mobile No string Conditional
and Engine No not filled
(Alphanumeric only)

Output Parameters
Column Name Description DataType Length
ErrorCode 0 - Failed int
1 - Success
2 - No data found
ErrorMessage Error/Success message string
MobileNo Mobile No where OTP sent. string
Implementation Approach Website API Integration
2. OTP Verification:
 OTP Verification API (Exposed by HIIB)
 HIIB is exposing the function, named VerifyOTP. This function will accept 2 parameters and return
status of the action with list of policies is exists.
 The details of the input and output parameters of function VerifyOTP are mentioned in tables
below:

 Input Parameters
Column Name Description DataType Length Mandatory
MobileNo Mobile No is mandatory (Numeric string Y
Only)
OTP OTP shared on Mobile No or EmailID int Y

Output Parameters
Column Name Description DataType Length
ErrorCode 0 - Failed int
1 - Success
ErrorMessage Error/Success message string
PoliciesData List of all active policies with below
fields.
PolicyNo string
RenewalDate string
Model string
Variant string

3. Get Models:
 Get Models List API (Exposed by HIIB)
 HIIB is exposing the function, named GetModels. This function will accept 0 parameters and
return list of models along with IDs.
 The details of the input and output parameters of function GetModels are mentioned in tables
below:

Output Parameters
Column Name Description DataType Length
ModelId Unique numeric ID int
ModelName Name of models string 500

4. Get Variants:
 Get Variants List API (Exposed by HIIB)
 HIIB is exposing the function, named GetVariants. This function will accept 1 parameters and
return list of variants against that ModelId.
 The details of the input and output parameters of function GetVariants are mentioned in tables
below:

Implementation Approach Website API Integration


 Input Parameters
Column Name Description DataType Length Mandatory
ModelId Integer ID of model int Y

Output Parameters
Column Name Description DataType Length
VariantId Integer Variant ID int
VariantName Name of the Variants string 500

5. New Registration:
 New Registration Submission API (Exposed by HIIB)
 HIIB is exposing the function, named AddNewUsers. This function will accept 6 parameters and
return status of the action.
 The details of the input and output parameters of function AddNewUsers are mentioned in tables
below:

 Input Parameters
Column Name Description DataType Length Mandatory
CustomerName Customer name string Y
MobileNo Numeric Mobile No int Y
RegistrationNo Registration No without special string Y
characters
Address Address of the Customer string Y
ModelId Model ID int Y
VariantId Variant ID int Y

Output Parameters
Column Name Description DataType Length
ErrorCode 0 - Failed int
1 - Success
ErrorMessage Error/Success message string

6. Download Policy:
 Download Policy API (Exposed by HIIB)
 HIIB is exposing the function, named DownloadPolicy. This function will accept 2 parameters and
return status of the action with Base64 policy PDF code.
 The details of the input and output parameters of function DownloadPolicy are mentioned in
tables below:

 Input Parameters
Column Name Description DataType Length Mandatory
ActionType D - Download Only, E - Email Only, B - string Y
Both
PolicyNo Policy No string Y

Implementation Approach Website API Integration


Output Parameters
Column Name Description DataType Length
ErrorCode 0 - Failed int
1 - Success
ErrorMessage Error/Success message string
PolicyString Base64 string of PDF string

7. Get Policy Details:


 Get Policy Details API (Exposed by HIIB)
 HIIB is exposing the function, named GetRenewalPolicy. This function will accept 1 parameter and
return policy details.
 The details of the input and output parameters of function GetRenewalPolicy are mentioned in
tables below:

 Input Parameters
Column Name Description DataType Length Mandatory
PolicyNo Policy No string Y

Output Parameters
Column Name Description DataType Length
PolicyNo Policy No shared string
Name of proposer in case of
ProposerName string
individual policy
Name of company in case of
CompanyName string
corporate policy
Contact Person name in case of
ContactPersonName string
corporate policy
ProposalType I - Individual, C - Corporate string
MobileNo1 Primary mobile no int
MobileNo2 First alternate mobile no int
MobileNo3 Second alternate mobile no int
MobileNo4 Third alternate mobile no int
EmailID Customer email ID string
PANNo Customer PAN No string
DOB Customer DOB string
GSTINo Customer GSTI No string
Address1 Customer Addres s1 string
Address2 Customer Addres s2 string
Address3 Customer Addres s3 string
StateId Customer state ID string
CityId Customer City ID int
PinCode Customer pincode string
AadhaarNo Customer Aadhaar No string
CKYC Customer CKYC string
NomineName Customer nomine Name string
NomineAge Customer nomine Age int
NomineRelation Customer nomine Relation string
Implementation Approach Website API Integration
RegistrationNo Vehicle Registration No string
EngineNo Vehicle Engine No string
ChassisNo Vehicle Chassis No string
Model Vehicle Model string
Variant Vehicle Variant string
RegistrationDate Vehicle Registration Date date
IsTransferCase Transfer check of the vehicle int
IsClaimTaken Claim is taken or not int
LastYearNCBPer Last year NSC int
Electrical Electrical Invoice Value int
NonElectrical Non Electrical Invoide Value int
Geographical Values
GeoExtension Selected(Comma seperated string
string)
ISCPACover If CPA is taken for TP part int
CPATenure Tenure of CPA taken int
If PA Unnammed Passenger for
IsPAUnnammedPassenger int
TP Part
IsPaidDriver Is Paid Driver for TP Part int
Legal Liability Paid Driver for TP
LegalLiabilityPD int
Part
Legal Liability Unnammed
LegalLiabilityUnnammed int
Passenger for TP Part
OtherTPPolicyNo TP Policy No in case of IsActiveTP string
OtherTPIC TP IC in case of IsActiveTP int
TP Start Date in case of
OtherTPStartDate string
IsActiveTP (MM/dd/yyyy)
TP End Date in case of IsActiveTP
OtherTPEndDate string
(MM/dd/yyyy)

8. States List:
 Get States List API (Exposed by HIIB)
 HIIB is exposing the function, named GetStateList. This function will accept 0 parameters and
return list of states.
 The details of the input and output parameters of function GetStateList are mentioned in tables
below:

Output Parameters
Column Name Description DataType Length
StateId Unique numeric ID int
StateName Name of States string
StateCode Unique State RTO Codes string

9. Get Cities:
 Get Cities List API (Exposed by HIIB)
 HIIB is exposing the function, named GetCityList. This function will accept 1 parameter and return
list of cities against that StateId.
 The details of the input and output parameters of function GetCityList are mentioned in tables
Implementation Approach Website API Integration
below:

 Input Parameters
Column Name Description DataType Length Mandatory
StateId Numeric Id of the state int Y

Output Parameters
Column Name Description DataType Length
CityId Unique numeric ID int
CityName Name of Cities string 500

10. Get Masters:


 Get Masters API (Exposed by HIIB)
 HIIB is exposing the function, named GetProposalMaster. This function will accept 1 parameter
and return list of masters – Cover Type, PA Unnammed Passenger and Geo Areas.
 The details of the input and output parameters of function GetProposalMaster are mentioned in
tables below:

 Input Parameters
Column Name Description DataType Length Mandatory
PolicyNo PolicyNo String Y

Output Parameters
Column Name Description DataType Length
CoverTypes List of cover types
CoverTypeId Cover Type ID int
CoverTypeName Cover Types string
GeographicalAreas List of Geographical Areas
GeographicalAreaId Geographical Area ID int
GeographicalAreaName Geographical Area Name string
PAUnnammedList List of PA Unnammed Passenger Cover
PAUnnamedLabel PA Unnammed Passenger Cover Text string
PAUnnamedValue PA Unnammed Passenger Cover Value string

11. Phone/Email OTP Generation:


 Phone/Email OTP Generation API (Exposed by HIIB)
 HIIB is exposing the function, named GetPhoneEmailOTP. This function will accept 2 parameters
and return status against the operation.
 The details of the input and output parameters of function GetPhoneEmailOTP are mentioned in
tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
MobileNo MobileNo is required is Email ID is blank. int Conditional
EmailID EmailID is required if MobileNo is blank. string Conditional

Implementation Approach Website API Integration


Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200
12. Phone/Email OTP Verification:
 Phone/Email OTP Verification API (Exposed by HIIB)
 HIIB is exposing the function, named VerifyPhoneEmailOTP. This function will accept 3
parameters and return status against the operation.
 The details of the input and output parameters of function VerifyPhoneEmailOTP are mentioned
in tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
MobileNo MobileNo is required is Email ID is blank. int Conditional
EmailID EmailID is required if MobileNo is blank. string Conditional
OTP OTP Shared Int Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200

13. Save Customer Proposal:


 Save Customer Proposal API (Exposed by HIIB)
 HIIB is exposing the function, named SaveCustomerProposal. This function will accept 42
parameters and return status against the operation.
 The details of the input and output parameters of function SaveCustomerProposal are mentioned
in tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
PolicyNo Policy No string Y
Name of proposer in case of
ProposerName string Y
individual policy
Name of company in case of
CompanyName string Y
corporate policy
Contact Person name in case of
ContactPersonName string Y
corporate policy
ProposalType I - Individual, C - Corporate string Y
MobileNo1 Primary mobile no int Y
MobileNo2 First alternate mobile no int Y
MobileNo3 Second alternate mobile no int Y
MobileNo4 Third alternate mobile no int Y
EmailID Customer email ID string Y
PANNo Customer PAN No string Y
DOB Customer DOB string Y

Implementation Approach Website API Integration


GSTINo Customer GSTI No string Y
Address1 Customer Addres s1 string Y
Address2 Customer Addres s2 string Y
Address3 Customer Addres s3 string Y
StateId Customer state ID string Y
CityId Customer City ID int Y
PinCode Customer pincode string Y
AadhaarNo Customer Aadhaar No string Y
CKYC Customer CKYC string Y
NomineName Customer nomine Name string Y
NomineAge Customer nomine Age int Y
NomineRelation Customer nomine Relation string Y
RegistrationNo Vehicle Registration No string Y
EngineNo Vehicle Engine No string Y
ChassisNo Vehicle Chassis No string Y
Model Vehicle Model string Y
Variant Vehicle Variant string Y
RegistrationDate Vehicle Registration Date date Y
IsTransferCase Transfer check of the vehicle int Y
IsClaimTaken Claim is taken or not int Y
LastYearNCBPer Last year NSC int Y
Electrical Electrical Invoice Value int N
NonElectrical Non Electrical Invoide Value int N
Geographical Values
GeoExtension Selected(Comma seperated string Y
string)
ISCPACover If CPA is taken for TP part int Y
CPATenure Tenure of CPA taken int Y
If PA Unnammed Passenger for
IsPAUnnammedPassenger int Y
TP Part
IsPaidDriver Is Paid Driver for TP Part int Y
Legal Liability Paid Driver for TP
LegalLiabilityPD int Y
Part
Legal Liability Unnammed
LegalLiabilityUnnammed int Y
Passenger for TP Part
IsActiveOD If there is an active OD Policy int N
IsActiveTP If there is an active TP Policy int N
OtherTPPolicyNo TP Policy No in case of IsActiveTP string N
OtherTPIC TP IC in case of IsActiveTP int N
OtherTPStartDate TP Start Date in case of IsActiveTP string N
OtherTPEndDate TP End Date in case of IsActiveTP string N

Output Parameters
Column Name Description DataType Length
Proposal ID created against the details
ProposalId int
saved

Implementation Approach Website API Integration


0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200

14. Get AddOns Master Data:


 Get AddOns Master Data API (Exposed by HIIB)
 HIIB is exposing the function, named GetAddonList. This function will accept 0 parameters and
return list of addons.
 The details of the input and output parameters of function GetAddonList are mentioned in tables
below:

Output Parameters
Column Name Description DataType Length
AddOnId Unique numeric ID int
AddOnName Name of AddOn string 200
AddOnsShortCode ShortCode of AddOns string 4

15. Fetch Quotations:


 Fetch Quotations API (Exposed by HIIB)
 HIIB is exposing the function, named FetchQuotes. This function will accept 3 parameters and
return list of IC wise quotations.
 The details of the input and output parameters of function FetchQuotes are mentioned in tables
below:

 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Numeric ID of proposal int Y
IDVValue If user changes the IDV int N
AddOns Comma Seperated AddOn Ids string Y

Output Parameters
Column Name Description DataType Length
ExistingPolicyNo Policy no of the previous policy renewing string
ExistingInsuranceCompany Insurance company of previous policy string
NewIDV New IDV value int
ExistingAddOns List of Add-Ons opted in previous policy
AddOnId AddOnId int
AddOnName Name of the AddOn string
AddOnCode 2-3 digit code of the AddOn string
Quotations List of quotations of all Ics
ICName Insurance Company name string
Rating Rating of the Insurance Company decimal
SolvencyRatio Solvency Ratio of the Insurance decimal
Implementation Approach Website API Integration
Company
0 - Pending, 1 - KYC Done with the
KYCDone Insurance Company int
ExtraBenefit Extra Benefits %age decimal
TotalPremium Total Premium to pay int
AddOns List of Add-Ons opted in this policy
AddOnPackageId Add-On Package ID int
AddOnName Package Name string
AddOnTotalPremium Total Premium of the AddOns int
AddOnsIncluded List of Add-Ons included
AddOnId Add-On Id int
AddOnName Add-On Name string
AddOnCode 2-3 digit code of the AddOn string
AddOnPremium Premium of that Add-On int

16. IC-AddOns Selection Submission:


 IC-AddOns Selection Submission API (Exposed by HIIB)
 HIIB is exposing the function, named SaveAddOns. This function will accept 3 parameters and
return status against the operation.
 The details of the input and output parameters of function SaveAddOns are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Proposal Id int Y
InsuranceCompanyId Insurance Company Id selected int Y
AddOnsPackageId Add-Ons Package Id selected string Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200

17. Fetch KYC Status:


 Fetch KYC Status API (Exposed by HIIB)
 HIIB is exposing the function, named VerifyKYC. This function will accept 1 parameter and return
status against the operation.
 The details of the input and output parameters of function VerifyKYC are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Numeric Id of the proposal int Y

Output Parameters
Column Name Description DataType Length

Implementation Approach Website API Integration


0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200
IC URL in case the request is not 1000
ICKYCRequestURL satisfied. string
IC request form in case the request is
MAX
RedirectionURL not satisfied. string

18. KYC Status API:


 KYC Status API (Exposed by HIIB)
 HIIB is exposing the function, named KYC_StatusRequest. This function will accept 1 parameter
and return status against the operation.
 The details of the input and output parameters of function KYC_StatusRequest are mentioned in
tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Encrypted proposal ID string Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200

19. Pre-Inspection API:


 Pre-Inspection API (Exposed by HIIB)
 HIIB is exposing the function, named SavePIRequest. This function will accept 1 parameter and
return status against the operation along with PI_URL if available.
 The details of the input and output parameters of function SavePIRequest are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Encrypted proposal ID string Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200
ProposalId Encrypted proposal ID string 500
PI_URL Pre-inspection URL String 1000

Implementation Approach Website API Integration


20. Proposal Preview:
 Proposal Preview API (Exposed by HIIB)
 HIIB is exposing the function, named GetProposerPreviewData. This function will accept 1
parameter and return proposal details.
 The details of the input and output parameters of function GetProposerPreviewData are
mentioned in tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Encrypted Proposal ID string 500 Y

Output Parameters
Column Name Description DataType Length
ProposalId ProposalId int
Insurer Insurer full name string
ProposalNumber Proposal Number string
PolicyStartDate Policy Start Date - dd/mm/yyyy string
PolicyExpiryDate Policy Expiry Date - dd/mm/yyyy string
RegistrationNo Registration No string
VehicleModel Vehicle Model string
VehicleVariant Vehicle Variant string
TotalPremium Total Premium int
AddOns Add Ons List
AddOnName Add On Name string
AddOnCode Add On Code string
IsKYCDone KYC Status int
KYCICNo KYC IC Response No if KYC is completed string

21. Policy Transaction Data:


 Policy Transaction Data API (Exposed by HIIB)
 HIIB is exposing the function, named GetPaymentData. This function will accept 1 parameter and
return proposal transaction details.
 The details of the input and output parameters of function GetPaymentData are mentioned in
tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
ProposalId Encrypted Proposal ID string 500 Y

Output Parameters
Column Name Description DataType Length
PolicyNumber Proposal Number string
BankReferenceNo Policy Start Date - dd/mm/yyyy string
TransactionID Policy Expiry Date - dd/mm/yyyy string
TransactionAmount Registration No string
ProposalNo Vehicle Model string

Implementation Approach Website API Integration


22. Workshop List API:
 Workshop List API (Exposed by HIIB)
 HIIB is exposing the function, named GetWorkshop. This function will accept 1 parameter and
return status against the operation.
 The details of the input and output parameters of function GetWorkshop are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
CityId Numeric ID Int Y

Output Parameters
Column Name Description DataType Length
WorkshopId Unique numeric ID int
WorkshopName Name of Workshops string 500
WorkshopCode Workshop Code string 30

23. Claim Intimation:


 Claim Intimation API (Exposed by HIIB)
 HIIB is exposing the function, named ClaimIntimation. This function will accept 25 parameters and
return status of the operation.
 The details of the input and output parameters of function ClaimIntimation are mentioned in
tables below:
 Input Parameters
Column Name Description DataType Length Mandatory
VISoF policy number on which
InsPolicyNo string 50 Y
claim is intimated
Date of claim intimation Format -
IntimationDate date Y
MM/DD/YYYY
Time of claim intimation Format -
IntimationTime date Y
HH:MM:SS
Date of accident/ theft Format -
AccidentDate date Y
MM/DD/YYYY
Time of accident/ theft Format -
AccidentTime date Y
HH:MM:SS
AccidentPlace Place of accident/ theft string 50 Y
AccidentCity City code of accident/ theft int Y
AccidentState State code of accident/ theft int Y
Engine no. of vehicle on which
EngineNo string 25 N
claim is intimated, Blank for EV
Chassis no. of vehicle on which
ChassisNo string 25 Y
claim is intimated
Registration no. of vehicle on which
RegistrationNo claim is intimated without space string 25 Y
e.g : HR26AJ0002.
Nature of loss (partial loss, total
LossNature string 25 Y
loss, theft)
IsThirdPartyLoss Third party loss flag (1- yes, 0- no) int Y
Remarks Remarks, Claim description string 500 Y
Implementation Approach Website API Integration
InsuredName Insured name string 100 Y
MobileNumber Insured mobile number int 10 Y
IntimatorName Claim intimator name string 100 Y
Owner or representative mobile
ContactNumber int 10 Y
number
CustomerEmailID Customer Email ID string 50 N
At the time of accident whether
DriverType vehicle was driven by "Self" Or string 50 Y
"Other Driver" Or "Parked"
Driver name driving the vehicle at
DriverName string 100 N
the time of accident.
Value : Father, Mother, Brother,
Sister, Husband, Wife, Son,
DriverRelation string 50 N
Daughter, Friend, Driver,
Employee, Other Relative
DriverLicenseNumber Driver's driving license number string 50 N
DriverLicenseExpiryDate Driving License Expiry Date date N
Pincode Pincode int N

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string 200
ClaimNo ClaimNo against the request submitted. string 200

24. Claim Status:


 Claim Status API (Exposed by HIIB)
 HIIB is exposing the function, named ClaimStatus. This function will accept 2 parameters and
return Claim Status Details.
 The details of the input and output parameters of function ClaimStatus are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
PolicyNo Policy No to fetch claim details string 200 Optional
ClaimNo ClaimNo to fetch details string 200 Optional

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string
ClaimNo Active Claim No against given details string
ClaimStage Integer stage value int
ClaimStageName Current stage name string

Implementation Approach Website API Integration


25. Report Issue for Policy-Claim API:
 Report Issue for Policy-Claim API (Exposed by HIIB)
 HIIB is exposing the function, named ReportIssue. This function will accept 3 parameters and
return status of operation.
 The details of the input and output parameters of function ReportIssue are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
TransactionType P - Policy, C - Claim string 2 Y
PolicyNo Policy No string 200 Y
Remarks Remarks against the transaction type. string 500 Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string

26. Customer Feedback API:


 Customer Feedback API (Exposed by HIIB)
 HIIB is exposing the function, named Feedback. This function will accept 3 parameters and return
status of operation.
 The details of the input and output parameters of function Feedback are mentioned in tables
below:
 Input Parameters
Column Name Description DataType Length Mandatory
RegistrationNo Registration No string 50 Y
Stars Integer value int Y
Remarks Remarks against the transaction type. string 500 Y

Output Parameters
Column Name Description DataType Length
0 - Failed
ErrorCode int
1 - Success
ErrorMessage Message against errorcode string

Implementation Approach Website API Integration


User Prerequisites for Token Authentication Mechanism

● User need to obtain access token from Cognito authentication API provided, which they need to send
in Bearer Authentication header of Policy PDF API requests.
● User also need to pass user name & password information in headers to get response from APIs.

A: Parameters Required

App Client ID: 3uuhm26so1i4sm84o0or25tim5


App Client Secret: 1p425j0fakp739ks84eu74iqa8uv74h0jj1mnefagkmtuldgva23
grant_type: client_credentials
UserName: UG9saWN5UGRm
Password: UGFzc0AxMjM0

Domain:
https://hiib.auth.ap-south-1.amazoncognito.com/oauth2/token

B: Instructions Required

Method to post the Access Token:

Using Postman

Type – POST
URL - https://hiib.auth.ap-south-1.amazoncognito.com/oauth2/token

Method to generate OTP:

Type – POST
URL - https://digiwebuat.hiib.in/api/OTP/GetOTP

Method to verify OTP:

Type – POST
URL - https://digiwebuat.hiib.in/api/OTP/VerifyOTP

Method to Get Models:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetModels

Implementation Approach Website API Integration


Method to Variants:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetVariants?ModelId={ModelId}

Method to submit New Subscribers data:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/AddNewUsers

Method to download policy:

Type – POST
URL - https://digiwebuat.hiib.in/api/Policy/DownloadPolicy

Method to get policy details for renewal:

Type – POST
URL - https://digiwebuat.hiib.in/api/Policy/GetRenewalPolicy

Method to get States List:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetStateList

Method to get Cities List:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetCityList

Method to get Masters Data:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetProposalMaster

Method to generate Email/Mobile OTP:

Type – POST
URL - https://digiwebuat.hiib.in/api/OTP/GetPhoneEmailOTP

Implementation Approach Website API Integration


Method to verify Email/Mobile OTP:

Type – POST
URL - https://digiwebuat.hiib.in/api/OTP/VerifyPhoneEmailOTP

Method to verify Save Customer Details:

Type – POST
URL - https://digiwebuat.hiib.in/api/Policy/SaveCustomerProposal

Method to verify Save Customer Details:

Type – POST
URL - https://digiwebuat.hiib.in/api/Master/GetAddonList

Method to Fetch Quotes:

Type – POST
URL - https://digiwebuat.hiib.in/api/Quotation/FetchQuotes

Method to Fetch Quotes:

Type – POST
URL - https://digiwebuat.hiib.in/api/Policy/SaveAddOns

Method to KYC verification:

Type – POST
URL - https://digiwebuat.hiib.in/api/KYC/VerifyKYC

Method to verify Save Customer Details:

Type – POST
URL - https://digiwebuat.hiib.in/api/KYC/KYC_StatusRequest

Method to Get Proposal Preview Details:

Type – POST
URL - https://digiwebuat.hiib.in/api/Policy/GetProposerPreviewData

Implementation Approach Website API Integration


Method to submit PI(Pre-Inspection) Request:

Type – POST
URL - https://digiwebuat.hiib.in/api/PI/SavePIRequest

Method to do payment:

Type – POST
URL - https://uat.hiib.in/Payment/Payment/GetWebsitePGRequest?encProposalId=<ProposalId>

Method to Get Proposal Payment Details:

Type – POST
URL - https://digiwebuat.hiib.in/api/Payment/GetPaymentData

Method to get Workshop List

Type – GET
URL - https://digiwebuat.hiib.in/api/Claim/GetWorkshop?CityId=<CityID>

Method to Intimate Claim:

Type – POST
URL - https://digiwebuat.hiib.in/api/Claim/ClaimIntimation

Method to Check Claim Status:

Type – POST
URL - https://digiwebuat.hiib.in/api/Claim/ClaimStatus

Method to submit Policy/Claim Issue:

Type – POST
URL - https://digiwebuat.hiib.in/api/Claim/ReportIssue

Method to Check Claim Status:

Type – POST
URL - https://digiwebuat.hiib.in/api/Claim/Feedback

Implementation Approach Website API Integration


Integration Steps to generate access token for
consumption of APIs
Step 1: For the given token authentication URL under the body section mention the client_id, secret key in
JSON format.

Step 2: Click the Send button to generate the access token.

Implementation Approach Website API Integration


Step 3: Copy this access token and paste it in the OTP Generation API request under the Bearer Token
section in the authorization key.

Policy PDF UAT URL: https://digiwebuat.hiib.in/api/OTP/GetOTP

Token Expiry: 10 minutes

Note: For every request new real time token will be generated.

Step 4: Mention UserName and Password in the Header.

Implementation Approach Website API Integration


Step 5: Fill requested data in json format.

Step 6: Click on Send button to pass data for OTP Generation

Implementation Approach Website API Integration


Step 7: Repeat step 3 and 4 and pass required data in json format and click Send to verify OTP.

Step 8: Repeat step 3 and 4 and click Send to Get Models.

Implementation Approach Website API Integration


Step 9: Repeat step 3 and 4 and add ModelId in URL and click Send to Get Variants.

Step 10: Repeat step 3 and 4 and add json data in JSON field and click Send to submit new subscribers data.

Implementation Approach Website API Integration


Step 11: Repeat step 3 and 4 and add json data in JSON field and click Send to get base64 pdf string.

Step 12: Repeat step 3 and 4 and pass required data in json format and click Send to get Policy Details.

Implementation Approach Website API Integration


Step 13: Repeat step 3 and 4 and click Send to Get States.

Step 14: Repeat step 3 and 4 and add json data in JSON field and click Send to Get Cities.

Implementation Approach Website API Integration


Step 15: Repeat step 3 and 4 and add json data in JSON field and click Send to Get Masters.

Step 16: Repeat step 3 and 4 and add json data in JSON field and click Send to Generate OTP.

Implementation Approach Website API Integration


Step 17: Repeat step 3 and 4 and add json data in JSON field and click Send to Verify OTP.

Step 18: Repeat step 3 and 4 and add json data in JSON field and click Send to Save Proposal Details.

Implementation Approach Website API Integration


Step 19: Repeat step 3 and 4 and click Send to Get AddOns List

Step 20: Repeat step 3 and 4 and add json data in JSON field and click Send to Fetch Quotations

Step 21: Repeat step 3 and 4 and add json data in JSON field and click Send to save selected addons and IC.

Implementation Approach Website API Integration


Step 22: Repeat step 3 and 4 and add json data in JSON field and click Send to Verify KYC

Step 23: If policy is breakin, use this APi to request for Pre-Inspection. Repeat step 3 and 4 and add json
data in JSON field and click Send to submit request.

Implementation Approach Website API Integration


Step 24: Repeat step 3 and 4 and add json data in JSON field and click get proposal preview details.

Step 25: Payment URL is simple and you can check with normal browser by entering the URL with proposal
ID.

Step 26: Repeat step 3 and 4 and add json data in JSON field and click get proposal payment details.

Implementation Approach Website API Integration


Step 27: Repeat step 3 and 4 and add click Send to get workshop details.

Step 28: Repeat step 3 and 4 and add json data in JSON field and click Send to submit details.

Implementation Approach Website API Integration


Step 29: Repeat step 3 and 4 and add json data in JSON field and click Send to get claim status.

Step 30: Repeat step 3 and 4 and add json data in JSON field and click Send to submit issue request.

Implementation Approach Website API Integration


Step 31: Repeat step 3 and 4 and add json data in JSON field and click Send to submit feedback.

Implementation Approach Website API Integration


1. OTP Generation
Request:
{
"RegistrationNo": "sample1",
"PolicyNo": "sample2",
"MobileNo": "9999999999",
"EngineNo": "sample4",
"ChassisNo": "sample5"
}

Response:
{
"MobileNo": "9999999999",
"ErrorCode": "1",
"ErrorMessage": "OTP has been sent on your Mobile No."
}

2. OTP Verification
Request:
{
"MobileNo": "9999999999",
"OTP": "1941"
}

Response:
{
"ErrorCode": "1",
"ErrorMessage": "OTP has been verified successfully.",
"PoliciesData": null
}

3. Get Models
Response:
[
{
"ModelId": 2,
"ModelName": "ACCENT"
},
{
"ModelId": 34,
"ModelName": "ALCAZAR"
},
{
"ModelId": 33,
"ModelName": "ALL NEW I20"
},
{

Implementation Approach Website API Integration


"ModelId": 37,
"ModelName": "ALL NEW TUCSON"
}
]

4. Get Variants:
Request: https://digiwebuat.hiib.in/api/Master/GetVariants?ModelId=2

Response:
[
{
"VariantId": 1345,
"VariantName": "1.5 LITRE DIESEL"
},
{
"VariantId": 1344,
"VariantName": "1.5 LITRE PETROL"
},
{
"VariantId": 1346,
"VariantName": "1.6 LITRE PETROL"
},
{
"VariantId": 837,
"VariantName": "CRDI E2"
}
]

5. New Subscriber Data Submission:


Request:
{
"CustomerName": "sample string 1",
"MobileNo": 9999999999,
"RegistrationNo": "DL-09-QW-2332",
"Address": "sample string 4",
"ModelId": 5,
"VariantId": 6
}

Response:
{
"ErrorCode": 1,
"ErrorMessage": "Data has been submitted successfully."
}

Implementation Approach Website API Integration


6. Policy PDF Download:
Request:
{
"ActionType": "D",
"PolicyNo": "996092323090000005"
}

Response:
{
"ErrorCode": 1,
"ErrorMessage": "Success",
"PolicyString": "Base64....."
}

7. Get Policy Details:


Request:
{
"PolicyNo": "3001/HY-10277633/00/000"
}

Response:
{
"PolicyNo": "3001/HY-10277633/00/000",
"ProposerName": "MR. MANISH MANISHTEST",
"CompanyName": "",
"ContactPersonName": "MR. MANISH MANISHTEST",
"ProposalType": "I",
"MobileNo1": "9999999999",
"MobileNo2": null,
"MobileNo3": null,
"MobileNo4": null,
"EmailID": "[email protected]",
"PANNo": "",
"DOB": "2004-12-01T00:00:00",
"GSTINo": null,
"Address1": "TEST",
"Address2": "NEAR METRO CITY",
"Address3": "BOTANICAL GARDEN",
"StateId": 9,
"CityId": 167,
"PinCode": "110051",
"AadhaarNo": "",
"CKYC": null,
"NomineName": "NOMINEE NAME",
"NomineAge": 45,
"NomineRelation": "BROTHER",
"RegistrationNo": "",
"EngineNo": "G4LFNM283721",
"ChassisNo": "MALBJ512LNM169158",
Implementation Approach Website API Integration
"Model": "ALL NEW I20",
"Variant": "I20 ASTA 1.2 KAPPA MT",
"RegistrationDate": null,
"IsTransferCase": 0,
"IsClaimTaken": 0,
"LastYearNCBPer": 0,
"Electrical": 0,
"NonElectrical": 0,
"GeoExtension": null,
"ISCPACover": 1,
"CPATenure": 3,
"IsPAUnnammedPassenger": 0,
"IsPaidDriver": 0,
"LegalLiabilityPD": 1,
"LegalLiabilityUnnammed": 0,
"OtherTPPolicyNo": "",
"OtherTPIC": 0,
"OtherTPStartDate": "",
"OtherTPEndDate": ""

8. Get States:
Response:
[
{
"StateId": 1,
"StateName": "ANDAMAN ISLANDS",
"StateCode": "AN"
},
{
"StateId": 2,
"StateName": "ANDHRA PRADESH",
"StateCode": "AP,TS"
},
{
"StateId": 3,
"StateName": "ARUNACHAL PRADESH",
"StateCode": "AR"
},
{
"StateId": 4,
"StateName": "ASSAM",
"StateCode": "AS"
}
]

9. Get Cities:
Request:
Implementation Approach Website API Integration
{
"StateId": 1
}

Response:
[
{
"CityId": 1,
"CityName": "ANDAMAN"
},
{
"CityId": 2,
"CityName": "CAR NICOBAR"
},
{
"CityId": 11603,
"CityName": "GARACHARMA"
},
{
"CityId": 9541,
"CityName": "GREAT NICOBAR"
}
]

10. Get Masters:


Request:
{
"PolicyNo": "3001/HY-10277633/00/000"
}

Response:
{
"CoverTypes": [
{
"CoverTypeId": 1,
"CoverTypeName": "1 OD + 1 TP"
},
{
"CoverTypeId": 2,
"CoverTypeName": "0 OD + 1 TP"
},
{
"CoverTypeId": 6,
"CoverTypeName": "1 OD + 0 TP"
}
],
"GeographicalAreas": [
{
"GeographicalAreaId": 6,
Implementation Approach Website API Integration
"GeographicalAreaName": "Bangladesh"
},
{
"GeographicalAreaId": 3,
"GeographicalAreaName": "Bhutan"
},
{
"GeographicalAreaId": 5,
"GeographicalAreaName": "Maldives"
},
{
"GeographicalAreaId": 2,
"GeographicalAreaName": "Nepal"
},
{
"GeographicalAreaId": 1,
"GeographicalAreaName": "Pakistan"
},
{
"GeographicalAreaId": 4,
"GeographicalAreaName": "Sri Lanka"
}
],
"PAUnnammedList": [
{
"PAUnnamedLabel": "200000",
"PAUnnamedValue": "2,00,000"
},
{
"PAUnnamedLabel": "100000",
"PAUnnamedValue": "1,00,000"
},
{
"PAUnnamedLabel": "90000",
"PAUnnamedValue": "90,000"
},
{
"PAUnnamedLabel": "80000",
"PAUnnamedValue": "80,000"
},
{
"PAUnnamedLabel": "70000",
"PAUnnamedValue": "70,000"
},
{
"PAUnnamedLabel": "60000",
"PAUnnamedValue": "60,000"
},
{
Implementation Approach Website API Integration
"PAUnnamedLabel": "50000",
"PAUnnamedValue": "50,000"
},
{
"PAUnnamedLabel": "40000",
"PAUnnamedValue": "40,000"
},
{
"PAUnnamedLabel": "30000",
"PAUnnamedValue": "30,000"
},
{
"PAUnnamedLabel": "20000",
"PAUnnamedValue": "20,000"
},
{
"PAUnnamedLabel": "10000",
"PAUnnamedValue": "10,000"
}
]
}

11. Email/Mobile OTP Generation:


Request:
{
"MobileNo": "9999999999",
"EmailID": ""
}

Response:
{
"ErrorCode": "1",
"ErrorMessage": "OTP has been sent on your Mobile No."
}

12. Email/Mobile OTP Verification:


Request:
{
"MobileNo": "9999999999",
"EmailID": "",
"OTP": 7476
}

Response:
{
"ErrorCode": "1",
"ErrorMessage": "OTP has been verified successfully."
}
13. Save Customer Proposal Details:
Implementation Approach Website API Integration
Request:
{
"PolicyNo": "sample string 1",
"ProposerName": "sample string 2",
"CompanyName": "sample string 3",
"ContactPersonName": "sample string 4",
"ProposalType": "sample string 5",
"MobileNo1": "sample string 6",
"MobileNo2": "sample string 7",
"MobileNo3": "sample string 8",
"MobileNo4": "sample string 9",
"EmailID": "sample string 10",
"PANNo": "sample string 11",
"DOB": "sample string 12",
"GSTINo": "sample string 13",
"Address1": "sample string 14",
"Address2": "sample string 15",
"Address3": "sample string 16",
"StateId": 17,
"CityId": 18,
"PinCode": 19,
"AadhaarNo": "sample string 20",
"CKYC": "sample string 21",
"NomineName": "sample string 22",
"NomineAge": 23,
"NomineRelation": "sample string 24",
"RegistrationNo": "sample string 25",
"EngineNo": "sample string 26",
"ChassisNo": "sample string 27",
"Model": "sample string 28",
"Variant": "sample string 29",
"RegistrationDate": "sample string 30",
"IsTransferCase": 31,
"IsClaimTaken": 32,
"LastYearNCBPer": 33,
"Electrical": 34,
"NonElectrical": 35,
"GeoExtension": "sample string 36",
"ISCPACover": 37,
"CPATenure": 38,
"IsPAUnnammedPassenger": 39,
"IsPaidDriver": 40,
"LegalLiabilityPD": 41,
"LegalLiabilityUnnammed": 42
}

Response:
Implementation Approach Website API Integration
{
"ProposalId": 9999,
"ErrorCode": "1",
"ErrorMessage": "Data has been submitted successfully."
}

14. Get AddOns Master Data:


Response:
[
{
"AddOnId": 1,
"AddOnName": "Zero Depreciation",
"AddOnsShortCode": "ZD"
},
{
"AddOnId": 9,
"AddOnName": "Consumables",
"AddOnsShortCode": "CM"
},
{
"AddOnId": 5,
"AddOnName": "Engine Protect",
"AddOnsShortCode": "EP"
},
{
"AddOnId": 6,
"AddOnName": "Return to Invoice",
"AddOnsShortCode": "RTI"
},
{
"AddOnId": 7,
"AddOnName": "Key Protect",
"AddOnsShortCode": "KP"
},
{
"AddOnId": 2,
"AddOnName": "Personal Belonging",
"AddOnsShortCode": "PB"
}
]

15. Fetch Quotations:


Request:
{
"ProposalId": 328220,
"IDVValue": 0,
"AddOns": "1,2,5,6,7,9"
}
Response:
Implementation Approach Website API Integration
{
"ExistingPolicyNo": "TEST0123456",
"ExistingInsuranceCompany": "ICICI Lombard",
"NewIDV": 522500,
"ExistingAddOns": [
{
"AddOnId": 6,
"AddOnName": "Return to Invoice",
"AddOnCode": "RTI"
}
],
"Quotations": [
{
"ICName": "ICICI Lombard",
"Rating": 4.5,
"SolvencyRatio": 3,
"KYCDone": 0,
"ExtraBenefit": 3.4,
"TotalPremium": 49203,
"AddOns": [
{
"AddOnPackageId": 4741,
"AddOnName": "ZD+CM+EP+RTI",
"AddOnTotalPremium": 4742,
"AddOnsIncluded": [
{
"AddOnId": 1,
"AddOnName": "Zero Depreciation",
"AddOnCode": "ZD",
"AddOnPremium": 2352
},
{
"AddOnId": 2,
"AddOnName": "Consumables",
"AddOnCode": "CM",
"AddOnPremium": 262
},
{
"AddOnId": 3,
"AddOnName": "Engine Protect",
"AddOnCode": "EP",
"AddOnPremium": 784
},
{
"AddOnId": 6,
"AddOnName": "Return to Invoice",
"AddOnCode": "RTI",
"AddOnPremium": 1045
},
Implementation Approach Website API Integration
{
"AddOnId": 5,
"AddOnName": "Key Protect",
"AddOnCode": "KP",
"AddOnPremium": 99
},
{
"AddOnId": 7,
"AddOnName": "Personal Belonging",
"AddOnCode": "PB",
"AddOnPremium": 199
}
]
}
]
}
]
}

16. IC-AddOns Selection Submission:


Request:
{
"ProposalId": "sample string 1",
"InsuranceCompanyId": 2,
"AddOnsPackageId": "3,1"
}
Response:
{
"ErrorCode": 1,
"ErrorMessage": "Data has been submitted successfully."
}

17. Verify KYC:


Request:
{
"ProposalId": 328220
}

Response:
{
"ErrorCode": 0,
"ErrorMessage": "Failed",
"ICKYCRequestURL":
"https://szuat.reliancegeneral.co.in:100/kyc/e2kyc?ID=E1JCMqQkBwbMA8re2K4jcUT+wnca8Tg6EFab
wxCsrrq/VtKp7boUJG8IFcXKLCsZwsVk/fGDPbIEDtoxKNOvzts2EODInOpfPwiFhQpX1f3KK7M4gG/Ypgdf
Ilx8DceEWhXOZD3VqgCWuxAKPGEESairpL8YVZlB84VlVXOn1irLmW3iwTBhvI6Pl4TCaHrE",
"RedirectionURL": "<form id=\"KYCFailedFormTag\" method =\"post\" name=\"redirect\"
action=\"https://szuat.reliancegeneral.co.in:100/kyc/e2kyc?ID=E1JCMqQkBwbMA8re2K4jcUT+wnca8
Implementation Approach Website API Integration
Tg6EFabwxCsrrq/VtKp7boUJG8IFcXKLCsZwsVk/fGDPbIEDtoxKNOvzts2EODInOpfPwiFhQpX1f3KK7M4g
G/YpgdfIlx8DceEWhXOZD3VqgCWuxAKPGEESairpL8YVZlB84VlVXOn1irLmW3iwTBhvI6Pl4TCaHrE\"
>\r\n<input type = \"hidden\" id = \"VISoF_KYC_Req_No\" name = \"VISoF_KYC_Req_No\" value =
\"HIHY-RGI-000836\"/>\r\n<input type = \"hidden\" id = \"IC_KYC_No\" name = \"IC_KYC_No\" value
= \"HIHY-RGI-000836\"/>\r\n<input type = \"hidden\" name = \"VISoF_Return_URL\" id =
\"VISoF_Return_URL\" value =
\"https://uat.hiib.in/Policy/KYC/KYCResponse?YXTFTKxCTLU57ZNM1HsXYwmsPfCauj6tcnwmO+PIGx
w=\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD1\" id = \"Other_Add_FLD1\" value =
\"\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD2\" id = \"Other_Add_FLD2\" value =
\"\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD3\" id = \"Other_Add_FLD3\" value =
\"\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD4\" id = \"Other_Add_FLD4\" value =
\"\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD5\" id = \"Other_Add_FLD5\" value =
\"\" />\r\n<input type = \"hidden\" name = \"Other_Add_FLD6\" id = \"Other_Add_FLD6\" value =
\"\" />\r\n<input id=\"KYCFailedForm\" type=\"submit\" form=\"KYCFailedFormTag\" value=\"Click
me\" >\r\n</form>\r\n"
}

18. Submit for PI Inspection:


Request:
{
"ProposalId": "DPLUSYEPTCLGGnstPJ958jZPg=="
}

Response:
{
"ProposalId": "DPLUSYEPTCLGGnstPJ958jZPg==",
"PI_URL": null,
"ErrorCode": "0",
"ErrorMessage": "This policy requires break-in inspection and cannot be renewed online. Kindly connect
with dealer MOHIT at 9870839897 or write to [email protected]."
}

19. Get Proposal Preview Details:


Request:
{
"ProposalId": "328551"
}

Response:
{
"ProposalId": 328551,
"Insurer": "M/S HITECH SPECIALITIES SOLUTIONS LIMITED",
"ProposalNumber": "HIIB309222",
"PolicyStartDate": "30-DEC-2023 (00:00) ",
"PolicyExpiryDate": "29-DEC-2024 (1 YEAR)",
"RegistrationNo": "mh-09-GF-7676",
"VehicleModel": "ALCAZAR",
"VehicleVariant": "ALCAZAR 1.5 MT PRESTIGE 7S",
"TotalPremium": 42820,
Implementation Approach Website API Integration
"IsKYCDone": 0,
"KYCICNo": "HIHY-RGI-000904",
"IsPIRequired": 0,
"IsPIDone": 0,
"AddOns": [
{
"AddOnName": "ZD+CM+RTI",
"AddOnCode": "ZD"
},
{
"AddOnName": "ZD+CM+RTI",
"AddOnCode": "CM"
},
{
"AddOnName": "ZD+CM+RTI",
"AddOnCode": "RTI"
},
{
"AddOnName": "ZD+CM+RTI",
"AddOnCode": "KP"
},
{
"AddOnName": "ZD+CM+RTI",
"AddOnCode": "PB"
}
]
}

20. Get Proposal Payment Details:


Request:
{
"ProposalId": "328560"
}

Response:
{
"PolicyNumber": "996092323110000076",
"BankReferenceNo": "",
"TransactionID": "",
"TransactionAmount": 0,
"ProposalNo": "HIIB309231"
}

21. Get Workshop List:


Response:
{
"WorkshopID": 2,
"WorkshopName": "N1200-Peeragarhi-New Delhi-Delhi",
"WorkshopCode": "N1200"
Implementation Approach Website API Integration
}

22. Claim Intimation:


Request:
{
"InsPolicyNo": "HAX/S9678595/000000/00",
"IntimationDate": "2020-11-17T17:03:20.4257965+05:30",
"IntimationTime": "17:03:20.4257965",
"AccidentDate": "2002-11-10T00:00:00",
"AccidentTime": "17:03:20.4247962",
"AccidentPlace": "goaJHV",
"AccidentCity": 5,
"AccidentState": 2,
"EngineNo": "OKTEST123456",
"ChassisNo": "OKTEST123456",
"RegistrationNo": "DL04ra3243",
"LossNature": "Theft",
"IsThirdPartyLoss": 1,
"Remarks": "Testing Claim Intimation request and status api. Testing Claim Intimation request and
status api.Testing Claim Intimation request and status api",
"InsuredName": "Test",
"MobileNumber": "9898989898",
"IntimatorName": "mndfgm",
"ContactNumber": "9898989898",
"CustomerEmailID": "[email protected]",
"DriverType": "Parked",
"DriverName": "fdsvgdfgdf",
"DriverRelation": "ONOWER",
"DriverLicenseNumber": "fdsvdsfd",
"DriverLicenseExpiryDate": "2002-11-10T00:00:00"
}

Response:
{
"ErrorCode": 1,
"ErrorMessage": "",
"ClaimNo": "DIGICLM000220"
}

23. Check Claim Status:


Request:
{
"PolicyNo": null,
"ClaimNo": "MOT01050390"
}

Response:
{
"ErrorCode": 1,
Implementation Approach Website API Integration
"ErrorMessage": "Data Found",
"ClaimNo": "MOT01050390",
"ClaimStage": "N",
"ClaimStageName": "CLAIM INTIMATION"
}

24. Submit Policy/Payment Issue:


Request:
{
"TransactionType": "P",
"PolicyNo": "123456789",
"Remarks": "Unable to submit policy details. Getting error message while submitting for payment."
}

Response:
{
"ErrorCode": 1,
"ErrorMessage": "DATA CREATED SUCCESSFULLY."
}

25. Submit Feedback:


Request:
{
"RegistrationNo": "HR10AD2221",
"Stars": 2,
"Remarks": "Unable to submit policy details. Getting error message while submitting for payment.
}

Response:
{
"ErrorCode": 1,
"ErrorMessage": "DATA CREATED SUCCESSFULLY."
}

Implementation Approach Website API Integration


FAQ’s
1. Is this service REST or SOAP?
This service will be REST API.

2. Is token authentication required for Policy PDF API service?


Yes, it is required, please refer Section “User Prerequisites for Token Authentication Mechanism”

3. What are the parameters needed to generate the token?


Please refer Section “User Prerequisites for Token Authentication Mechanism”

4. What is type of Authentication Token?


We are using Cognito/ JWT token generation and authentication process.

5. Where we required to send this token in request header or body?


Please refer screenshots in Step 3 under Section “Integration Steps to generate access token for
consumption of API”

6. Is this token life based then what is the life span for this token?
Yes, token expiry span is 10 minutes.

Implementation Approach Website API Integration

You might also like