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

Interface KycFacade

public interface KycFacade

This class used to integrate with kyc service

Author:

Sanjay Murali

Method Summary

Modifier and Type	Method	Description
AuthResponseDTO	authenticateIndividual(AuthRequestDTO authRequest, boolean request, String partnerId, String partnerApiKey, ObjectWithMetadata requestWithMetadata)	Authenticate individual.
AuthResponseDTO	authenticateIndividual(AuthRequestDTO authRequest, boolean request, String partnerId, String partnerApiKey, ObjectWithMetadata requestWithMetadata, boolean markVidConsumed)	Authenticate individual.
EKycAuthResponseDTO	processEKycAuth(EkycAuthRequestDTO eKycAuthRequestDTO, AuthResponseDTO authResponseDTO, String partnerId, Map<String,Object> metadata)	Process the EKycAuthRequestDTO to integrate with EKycService.
KycAuthResponseDTO	processKycAuth(AuthRequestDTO kycAuthRequestDTO, AuthResponseDTO authResponseDTO, String partnerId, String oidcClientId, Map<String,Object> metadata)	Process the KycAuthRequestDTO to integrate with KYCService.
KycExchangeResponseDTO	processKycExchange(KycExchangeRequestDTO kycExchangeRequestDTO, String partnerId, String oidcClientId, Map<String,Object> metadata, ObjectWithMetadata requestWithMetadata)	Process the KycExchangeRequestDTO to integrate with KYCService.

Method Detail

processEKycAuth

EKycAuthResponseDTO processEKycAuth(@Nonnull
                                    EkycAuthRequestDTO eKycAuthRequestDTO,
                                    AuthResponseDTO authResponseDTO,
                                    String partnerId,
                                    Map<String,Object> metadata)
                             throws IdAuthenticationBusinessException

Process the EKycAuthRequestDTO to integrate with EKycService.

Parameters:

eKycAuthRequestDTO - is DTO of KycAuthRequestDTO

authResponseDTO - the auth response DTO

partnerId - the partner id

metadata - the metadata

Returns:

the kyc auth response DTO

Throws:

IdAuthenticationBusinessException - the id authentication business exception

authenticateIndividual

AuthResponseDTO authenticateIndividual(AuthRequestDTO authRequest,
                                       boolean request,
                                       String partnerId,
                                       String partnerApiKey,
                                       ObjectWithMetadata requestWithMetadata)
                                throws IdAuthenticationBusinessException,
                                       IdAuthenticationDaoException

Authenticate individual.

Parameters:

authRequest - the auth request

request - the request

partnerId - the partner id

Returns:

the auth response DTO

Throws:

IdAuthenticationBusinessException - the id authentication business exception

IdAuthenticationDaoException - the id authentication dao exception

authenticateIndividual

AuthResponseDTO authenticateIndividual(AuthRequestDTO authRequest,
                                       boolean request,
                                       String partnerId,
                                       String partnerApiKey,
                                       ObjectWithMetadata requestWithMetadata,
                                       boolean markVidConsumed)
                                throws IdAuthenticationBusinessException,
                                       IdAuthenticationDaoException

Authenticate individual.

Parameters:

authRequest - the auth request

request - the request

partnerId - the partner id

partnerApiKey - the partner api key id

requestWithMetadata - the request object with metadata

markVidConsumed - flag to mark id/vid consumed.

Returns:

the auth response DTO

Throws:

IdAuthenticationBusinessException - the id authentication business exception

IdAuthenticationDaoException - the id authentication dao exception

processKycAuth

KycAuthResponseDTO processKycAuth(@Nonnull
                                  AuthRequestDTO kycAuthRequestDTO,
                                  AuthResponseDTO authResponseDTO,
                                  String partnerId,
                                  String oidcClientId,
                                  Map<String,Object> metadata)
                           throws IdAuthenticationBusinessException

Process the KycAuthRequestDTO to integrate with KYCService.

Parameters:

kycAuthRequestDTO - is DTO of KycAuthRequestDTO

authResponseDTO - the auth response DTO

partnerId - the partner id

metadata - the metadata

Returns:

the kyc auth response DTO

Throws:

IdAuthenticationBusinessException - the id authentication business exception

processKycExchange

KycExchangeResponseDTO processKycExchange(KycExchangeRequestDTO kycExchangeRequestDTO,
                                          String partnerId,
                                          String oidcClientId,
                                          Map<String,Object> metadata,
                                          ObjectWithMetadata requestWithMetadata)
                                   throws IdAuthenticationBusinessException

Process the KycExchangeRequestDTO to integrate with KYCService.

Parameters:

kycExchangeRequestDTO - is DTO of KycExchangeRequestDTO

partnerId - the partner id

oidcClientId - the client id

metadata - the metadata

requestWithMetadata - the request with metadata

Returns:

the kyc auth response DTO

Throws:

IdAuthenticationBusinessException - the id authentication business exception