Package io.mosip.authentication.core.spi.indauth.service

Interface KycService

public interface KycService

This interface is used to retrieve Kyc information of individual

Author:

Sanjay Murali

Method Summary

Modifier and Type	Method	Description
String	buildKycExchangeResponse(String subject, Map<String,List<IdentityInfoDTO>> idInfo, List<String> consentedAttributes, List<String> locales, String idVid, KycExchangeRequestDTO kycExchangeRequestDTO)	Method to build kyc exchange response to return user claims.
String	generateAndSaveKycToken(String idHash, String authToken, String oidcClientId, String requestTime, String tokenGenerationTime, String reqTransactionId)	Method used to generate the KYC Token after successful authentication and store the kyc token details in DB.
boolean	isKycTokenExpire(LocalDateTime tokenIssuedDateTime, String kycToken)	Method used to validate the input KYC Token is expired or not.
EKycResponseDTO	retrieveKycInfo(List<String> eKycTypeAttributes, Set<String> langCodes, Map<String,List<IdentityInfoDTO>> identityInfo)	Method used to retrieve the KYC information as per the policy

Method Detail

retrieveKycInfo

EKycResponseDTO retrieveKycInfo(List<String> eKycTypeAttributes,
                                Set<String> langCodes,
                                Map<String,List<IdentityInfoDTO>> identityInfo)
                         throws IdAuthenticationBusinessException

Method used to retrieve the KYC information as per the policy

Parameters:

uin - the individualId of the Resident

eKycTypeAttributes - the policy described for partner

secLangCode - - secondary language code to be sent if details need

identityInfo - the information contains personal information of the resident

Returns:

the kycResponseDTO consists of the KYC Information of the resident

Throws:

IdAuthenticationBusinessException - the id authentication business exception

generateAndSaveKycToken

String generateAndSaveKycToken(String idHash,
                               String authToken,
                               String oidcClientId,
                               String requestTime,
                               String tokenGenerationTime,
                               String reqTransactionId)
                        throws IdAuthenticationBusinessException

Method used to generate the KYC Token after successful authentication and store the kyc token details in DB.

Parameters:

idHash - Id Hash of the inputted Id

authToken - Partner specific User Token

oidcClientId - OIDC Client Id

requestTime - Auth Request Time

tokenGenerationTime - Token Generation Time

reqTransactionId - Request Transaction Id

Returns:

the String generated Kyc Token

Throws:

IdAuthenticationBusinessException - the id authentication business exception

isKycTokenExpire

boolean isKycTokenExpire(LocalDateTime tokenIssuedDateTime,
                         String kycToken)
                  throws IdAuthenticationBusinessException

Method used to validate the input KYC Token is expired or not.

Parameters:

tokenIssuedDateTime - Token Issued DataTime

kycToken - The KYC Token

Returns:

void

Throws:

IdAuthenticationBusinessException - the id authentication business exception

buildKycExchangeResponse

String buildKycExchangeResponse(String subject,
                                Map<String,List<IdentityInfoDTO>> idInfo,
                                List<String> consentedAttributes,
                                List<String> locales,
                                String idVid,
                                KycExchangeRequestDTO kycExchangeRequestDTO)
                         throws IdAuthenticationBusinessException

Method to build kyc exchange response to return user claims.

Parameters:

subject - Partner Specific token as subject for user claims

idInfo - List of Identity Info of the user.

consentedAttributes - Consented Attributes.

locales - selected locales.

idVid - individual Id

Returns:

String

Throws:

IdAuthenticationBusinessException - the id authentication business exception