Onboarding via Video KYC

Onboarding

Onboarding via Video KYC

Digitally onboard new customers from Partner platform by leveraging customer data to provide in-principle approval for their product of interest. It is integrated with Citi for Video KYC verification. Customers stay informed about the status of their application through an effective customer communication process.

India

Apply for Citi credit card

Transform the customer experience through a digital onboarding process. Customers can easily and conveniently apply for a Citi credit card and avail attractive offers from the Partner.
Zoom In

Customers provide personal details

Customers need to provide basic personal details to be shared with Citibank.
Zoom In

Customers provide additional details

Customers need to provide additional details like employment details to be shared with Citibank.

 

Refer to the below API callouts:

 

  • API Callout 1 for client credentials grant to retrieve the access token.
  • API Callout 2 to create a new application number.
  • API Callout 3 for in-principle approval.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Client Credentials Grant: Retrieve Access Token

This API is used to retrieve the access token for your application credentials. You can use this for APIs which do not require customer credential verification and consent (e.g. Onboarding).

Endpoint

India : POST /clientCredentials/oauth2/token/in/gcb

Parameters

FormData

grant_type

scope

View Api Callout 2 >
×

Use Case Callout

Create unsecured credit application

This API pre-populates an application for card and banking products with the applicant's details. The API will then return an application id that can be used to perform actions on the application and check status.

Endpoint

India : POST /v1/apac/onboarding/products/unsecured/applications

Parameters

PATH

NA

View Api Callout 3 >
×

Use Case Callout

Request credit application decision

Returns the results of a decision inquiry for an application, including credit limit, counter-product offers and cross-sell offers along with the list of required documents.

Endpoint

India : POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/inPrincipleApprovals

Parameters

PATH

applicationId

In-principle approval or rejection

Customers' applications are either approved or rejected, based on the details provided.

 

The application is submitted successfully once the customers click on 'Continue' button on the IPA screen.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Submit application

This API updates a saved application to correct information that was previously blank.

Endpoint

India : POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/submission

Parameters

PATH

applicationId

Body

FinalSubmitRequest (controlFlowId)

Application submitted successfully

The application is submitted successfully.

 

The customers need to click on 'Complete KYC' button to complete their verification via Video KYC.

Zoom In

Customers start Video KYC verification

Customers need to start Video KYC verification and keep their PAN card and Aadhaar handy. The Video KYC link is sent to the customer through SMS.

 

Refer to the below JWT API callout before redirection.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

RequestPartyAuthenticationAssessmentJwtGeneration

This API needs to be used to generate a JSON Web Token [JWT] and token can be either signed or could be signed and encrypted.

Endpoint

India : POST /v1/partyAuthentication/jwt/generation

Parameters

Body

RequestPartyAuthenticationAssessmentJwtGenerationRequest (applicationId)

Redirection to Citibank

The customer is redirected to Citibank for verification via Video KYC.
Zoom In

Welcome to Video KYC

Customers enter their application number and Aadhaar number on the Video KYC welcome screen in order to initiate the verification.

 

Refer to the below API callouts to trigger an OTP from UIDAI for a corresponding Aadhaar Number.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

AadhaarOtpRequest - GenerateOTP

The OTP Request API is used to trigger an OTP from UIDAI for a corresponding Aadhaar Number. The OTP is delivered to the mobile number and/or email id linked with the Aadhaar Number.

Endpoint

India : POST /v1/in/customers/identity/otp

Parameters

Body

AadhaarOtpRequest (aadhaarNumber, customerReferenceKey, customerReferenceValue, controlFlowId)

Customers enter the OTP

Customers enter the OTP received on their mobile number linked to their Aadhaar. Once the OTP is validated, the customer's application is retrieved.

 

Refer to the below API callouts:

 

  • API Callout 1 to validate the OTP.
  • API Callout 2 for application inquiry.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

AadhaarEkyc - ValidateOTP

The EKYC request is used to check the validity of an Aadhaar Number and at same time receive KYC information about the Aadhaar holder.

Endpoint

India : POST /v1/in/customers/identity/kyc

Parameters

Body

AadhaarEkycRequest (aadhaarNumber, customerReferenceKey, customerReferenceValue, residentConsentGivenFlag, verificationType, otp, transactionId, controlFlowId)

View Api Callout 2 >
×

Use Case Callout

Application Inquiry

This API returns the application details and status for a specific application id after a successful Multi Factor Authentication.

Endpoint

India : GET /v1/apac/onboarding/products/unsecured/applications/{applicationId}

Parameters

Path

applicationId

Query

controlFlowId

Customers verify name and permanent address as per Aadhaar and provide consent

Customers verify their names and permanent address as per Aadhaar.

 

Customers provide their consent for Citibank to retain their name and address as per the information received from UIDAI in order to proceed with Video KYC.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Update unsecured credit application

Updates a saved application to correct information that was previously blank.

Endpoint

India : PUT /v1/apac/onboarding/products/unsecured/applications/{applicationId}

Parameters

PATH

applicationId

Customers provide additional application details

Customers provide additional application details to be shared with Citibank in order to proceed with Video KYC.

 

Refer to the below API callouts:

 

  • API Callout 1 for updating the additional application details.
  • API Callout 2 (JWT API Callout) before redirection to Signzy.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Update unsecured credit application

Updates a saved application to correct information that was previously blank.

Endpoint

India : PUT /v1/apac/onboarding/products/unsecured/applications/{applicationId}

Parameters

PATH

applicationId

View Api Callout 2 >
×

Use Case Callout

Jwt Retrieval

This API needs to be used to retrieve a JSON Web Token [JWT].

Endpoint

India : POST /private/security/jwt

Parameters

Body

NA

Customers provide consent for recording and saving video and images

Customers provide their consent to complete the video identification process and to record and save the video and other images for the purpose of verification and KYC.
Zoom In

Check internet connection settings for video call

The system checks internet connection settings to setup the video call for verification.
Zoom In

Show queue position and waiting time to the customers

The system shows the position of the customers in the queue and shows them the approximate waiting time for connecting them to the Citibanker.

 

The customers can reschedule their Video KYC to another time if they wish to.

Zoom In

Customers are connected to Citibanker

The customers are connected to a Citibanker through video call.

 

The customers are prompted not to close the browser window or end the call before the verification is completed.

Zoom In

Customers place PAN card

The customers place their PAN card inside the box during the video verification process.
Zoom In

Customers voice out 6 digit number

The customers voice out the 6 digit number as displayed on the screen during the video verification process.
Zoom In

Citibanker takes customer's picture

The Citibanker takes the customer's picture during the video verification process.
Zoom In

Video KYC complete

The customer's Video KYC verification is complete and the customer's application is reviewed by Citibank.

 

The customer is communicated about the status of the application by Citibank.

 

Refer to the below API callouts:

 

  • API Callout 1 for client credentials grant to retrieve the access token.
  • API Callout 2 to update Video KYC assessment result.

 

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Client Credentials Grant: Retrieve Access Token

This API is used to retrieve the access token for your application credentials. You can use this for APIs which do not require customer credential verification and consent (e.g. Onboarding).

Endpoint

India : POST /clientCredentials/oauth2/token/in/gcb

Parameters

FormData

grant_type

scope

View Api Callout 2 >
×

Use Case Callout

UpdatePartyAuthenticationAssessmentVkycResult

This API is used to capture vKYC\ufffdresponse from Signzy.

Endpoint

India : PUT /v1/partyAuthentication/vkyc/{applicationId}/results

Parameters

PATH

applicationId

Body

UpdatePartyAuthenticationAssessmentVkycResultRequest (status, userRole, bankUserName, bankUserId, verificationDate)