Insurance Booking - Post Login

Insurance

Insurance Booking - Post Login

Customers can see available options and buy insurance that fit their needs without leaving the third-party platform.

Hong Kong

India

Malaysia

Singapore

Api's Called

Insurance
Customers

Create an entry point for customers to apply for products

Logged-in customers can apply for insurance directly from the My Accounts page of Citi MBOL app.
Zoom In

Display insurance options

Customers can select the type of insurance they want to purchase.
Zoom In

Display policy choices

Customers may review a selection of eligible policies and choose their preferred option.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorize code grant: Retrieve authorization code

The third-party calls the below API with the JWT token, the customer is then shown the consent page with the details of the data that will be shared with the third party for this journey. Once the customer selects "Agree," an AuthCode is generated and is sent to the third-party. 

Endpoint

Hong Kong: GET /authCode/oauth2/authorize

India: GET /authCode/oauth2/authorize

Malaysia: GET /authCode/oauth2/authorize

Singapore: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

jwt

response_type=code

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

 

Customer Consent

Customers can authorize Citi to share their data with trusted third-party providers.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Access Token

The third-party calls Citi with the Auth code. Citi then checks if Auth code is not expired and is still valid. In addition, Citi also checks if the Client ID and Secret are valid. Upon successful validation, Citi generates a customer specific token and returns it to partner.

Endpoint

Hong Kong: POST /authCode/oauth2/token/<countryCode>/<businessCode>

India: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Malaysia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Singapore: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

Query

NA

FormData

grant_type

code

redirect_uri

One-Time Pin (OTP) validation

Consenting customers can receive an OTP from Citi on their registered mobile number and then validate it. Once validated, Citi will share the customer’s profile details with the third-party and customers will be directed to the third-party site.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Customer Profile

The third-party calls the Customer Profile API to fetch the details of the customer. Citi then checks if the MFA was successful for the customer’s session. If the MFA is not triggered for the current session, Citi returns a 403 error to the third-party. 

Endpoint

Hong Kong: GET /partner/v1/customers/profiles

India: GET /partner/v1/customers/profiles

Malaysia: GET /partner/v1/customers/profiles

Singapore: GET /partner/v1/customers/profiles

 

Parameters

PATH

NA

Query

addressType

Body

NA

View Api Callout 2 >
×

Use Case Callout

MFA 

The third-party calls Citi's MFA page, whereby the customer enters their OTP code, sent to their registered mobile number. Citi then validates the OTP. After successful authentication, Citi will respond back with a success or error (in case validation failed) on the redirect URL registered by the third-party.  The MFA API is not available on the sandbox.

Endpoint

Hong Kong: /oauth2/mfa

India: /oauth2/mfa

Malaysia: /oauth2/mfa

Singapore: /oauth2/mfa

Parameters

PATH

Query

client_id

mfaCode

redirect_uri

Body

Response - 
<<Partner Redirect URI>>?mfaStatus=success&state=<<echo back whatever is sent in request>>

View Api Callout 3 >
×

Use Case Callout

Customer Profile

After receiving the success response from the MFA validation, the third-party calls the Customer Profile API again to fetch the necessary customer details. 

Endpoint

Hong Kong: GET /partner/v1/customers/profiles

India: GET /partner/v1/customers/profiles

Malaysia: GET /partner/v1/customers/profiles

Singapore: GET /partner/v1/customers/profiles

 

Parameters

PATH

NA

Query

addressType

Body

NA

Underwriting questionnaire

After selecting a product, customers take a questionnaire in order to proceed.
Zoom In

Product disclosure sheet

Customers review the product details in the product disclosure sheet in order to proceed.
Zoom In

Customer declaration

Customers can review and agree to the insurer's terms and conditions of the selected insurance product.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

InsuranceSourceAccountEligibility

This API returns customer’s source accounts eligible for insurance booking.

Endpoint

Hong Kong: GET /v1/insurance/bookings/sourceAccounts

India: GET /v1/insurance/bookings/sourceAccounts

Malaysia: GET /v1/insurance/bookings/sourceAccounts

Singapore: GET /v1/insurance/bookings/sourceAccounts

Parameters

PATH

NA

Query

NA

Body

NA

Purchase the policy

Customers can select which Citi account they’d like to use at purchase.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

CustomerInsuranceBooking

This API will debit the customer and pass the policy details to the insurance host.

Endpoint

Hong Kong: POST /v1/insurance/bookings

India: POST /v1/insurance/bookings

Malaysia: POST /v1/insurance/bookings

Singapore: POST /v1/insurance/bookings

Parameters

PATH

NA

Body

CustomerInsuranceBookingRequest

Booking confirmation

Customers can receive an acknowledgment on booking confirmation along with the policy number.
Zoom In