tech.paycon.sdk.v5

Class PCKYCManager

java.lang.Object

tech.paycon.sdk.v5.PCKYCManager

public class PCKYCManager
extends java.lang.Object

Works this PC KYC-Connector to perform the remote identification of the client before creating the key. The basic process of key acquisition includes the following steps:

1. Open a session initialized either by data extracted from QR-code or by directly provided URL of PC KYC-Connector and additional data as arbitrary JSON-string. To achieve this call either startSession(String, String, PCPushServiceType, SessionCallback) or startSession(String, String, String, String, PCPushServiceType, SessionCallback).
2. Check what types of sources are required for remote identification with PCKYCSession.getSourceSet().
3. Upload each required source with one of the following methods: uploadMedia(PCKYCSession, byte[], String, PCKYCSession.MediaSourceType, UploadMediaCallback) (uploads file as byte array), uploadMedia(PCKYCSession, InputStream, String, PCKYCSession.MediaSourceType, UploadMediaCallback) (uploads file as input stream), uploadMedia(PCKYCSession, File, PCKYCSession.MediaSourceType, UploadMediaCallback) (uploads file as java.io.File) or upload all the sources together with uploadAllMedia(PCKYCSession, HashMap, UploadMediaCallback).
4. Wait until status of the session changes to PCKYCSession.SessionStatus.OCR_SUCCESS. You can check current session status with help of getSessionStatus(PCKYCSession, SessionStatusCallback).
5. Download the parsed document from the server by calling getOCRResults(PCKYCSession, OCRResultsCallback) and show the parsed results to user so that they can verify that their documents have been scanned correctly.
6. After user confirms that the documents were delivered properly, invoke approveOCRResults(PCKYCSession, HandleOCRResultsCallback) to send the documents for further verification by authorities. If the user finds a mistake, call declineOCRResults(PCKYCSession, HandleOCRResultsCallback) to invalidate the results of analysis. Call getRequiredSources(PCKYCSession, RequiredSourcesCallback) to find out which sources must be uploaded again to restart the analysis.
7. After the correctly parsed documents were sent to verification, you have to wait until session status changes to PCKYCSession.SessionStatus.PCKEY_READY. As soon as this happens, call getPCUser(PCKYCSession, GetPCUserCallback) to obtain the actual PC key which is represented by PCUser object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PCKYCManager.GetPCUserCallback Callback to handle results of getPCUser(PCKYCSession, GetPCUserCallback)
static interface	PCKYCManager.HandleOCRResultsCallback Callback to handle results of approveOCRResults(PCKYCSession, HandleOCRResultsCallback) or declineOCRResults(PCKYCSession, HandleOCRResultsCallback)
static interface	PCKYCManager.OCRResultsCallback Callback to handle results of getOCRResults(PCKYCSession, OCRResultsCallback)
static interface	PCKYCManager.RequiredSourcesCallback Callback to handle results of getRequiredSources(PCKYCSession, RequiredSourcesCallback)
static interface	PCKYCManager.SessionCallback Callback to handle results of startSession(String, String, PCPushServiceType, SessionCallback)
static interface	PCKYCManager.SessionStatusCallback Callback to handle results of getSessionStatus(PCKYCSession, SessionStatusCallback)
static interface	PCKYCManager.StatusHistoryCallback Callback to handle results of getSessionStatus(PCKYCSession, SessionStatusCallback)
static interface	PCKYCManager.UploadMediaCallback Callback to handle results of uploadMedia(PCKYCSession, byte[], String, PCKYCSession.MediaSourceType, UploadMediaCallback), uploadMedia(PCKYCSession, InputStream, String, PCKYCSession.MediaSourceType, UploadMediaCallback), uploadMedia(PCKYCSession, File, PCKYCSession.MediaSourceType, UploadMediaCallback), uploadAllMedia(PCKYCSession, HashMap, UploadMediaCallback).

Constructor Summary

Constructors

Constructor and Description
PCKYCManager()

Method Summary

Modifier and Type	Method and Description
static void	approveOCRResults(PCKYCSession session, PCKYCManager.HandleOCRResultsCallback callback) Approves results of OCR.
static void	closeSession(PCKYCSession session) This function must be called after the PCUser acquired or after work with session is finished by another reason in order to delete session data from storage
static void	declineOCRResults(PCKYCSession session, PCKYCManager.HandleOCRResultsCallback callback) Declined results of OCR.
static void	deleteAllRestoredSessions() Delete any existing sessions in storage
static void	getOCRResults(PCKYCSession session, PCKYCManager.OCRResultsCallback callback) Gets results of OCR procedure.
static void	getPCUser(PCKYCSession session, PCKYCManager.GetPCUserCallback callback) Retrieves a PC key from server and returns PCUser object ready to be used in the app.
static void	getRequiredSources(PCKYCSession session, PCKYCManager.RequiredSourcesCallback callback) Gets required sources from server which must be uploaded again to succeed OCR
static void	getSessionStatus(PCKYCSession session, PCKYCManager.SessionStatusCallback callback) Retrieves the current status of the session
static void	getStatusHistory(PCKYCSession session, PCKYCManager.StatusHistoryCallback callback) Retrieves the history of statuses for a particular session
static java.util.List<PCKYCSession>	listSessions() Restores all previously stored sessions and returns the list of PCKYCSession objects
static void	startSession(java.lang.String sessionData, java.lang.String pushId, PCPushServiceType pushServiceType, PCKYCManager.SessionCallback callback) Starts session to interact with KYC-Connector.
static void	startSession(java.lang.String KYCConnectorUrl, java.lang.String systemId, java.lang.String appExtra, java.lang.String pushId, PCPushServiceType pushServiceType, PCKYCManager.SessionCallback callback) Starts session to interact with KYC-Connector.
static boolean	storeSession(PCKYCSession session) Stores session data in order to use later.
static void	uploadAllMedia(PCKYCSession session, java.util.HashMap<PCKYCSession.MediaSourceType,java.io.File> data, PCKYCManager.UploadMediaCallback callback) Uploads all required media to the server in order to perform an analysis
static void	uploadMedia(PCKYCSession session, byte[] data, java.lang.String fileExtension, PCKYCSession.MediaSourceType type, PCKYCManager.UploadMediaCallback callback) Uploads the media of specified type to the server in order to perform an analysis
static void	uploadMedia(PCKYCSession session, java.io.File data, PCKYCSession.MediaSourceType type, PCKYCManager.UploadMediaCallback callback) Uploads the media of specified type to the server in order to perform an analysis
static void	uploadMedia(PCKYCSession session, java.io.InputStream data, java.lang.String fileExtension, PCKYCSession.MediaSourceType type, PCKYCManager.UploadMediaCallback callback) Uploads the media of specified type to the server in order to perform an analysis

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PCKYCManager

public PCKYCManager()

Method Detail

startSession

public static void startSession(java.lang.String sessionData,
                                java.lang.String pushId,
                                PCPushServiceType pushServiceType,
                                PCKYCManager.SessionCallback callback)

Starts session to interact with KYC-Connector. PCKYCSession object is returned through callback in case of success
Includes following steps:
(1) Importing session data from QR-code (2) Key pair generation (3) Registration of public key (4) Saving received session ID for further interaction (5) Saving session to Shared Preferences

Parameters:

sessionData - Initial data required to initialize session. This data is JSON-body of decoded QR-code

pushId - Firebase Push token to receive notifications, may be null

pushServiceType - Type of service to work with pushes. One of values from PCPushServiceType. May be null if pushId is null. If pushId is not null, passing null value for this param has the same impact as if PCPushServiceType.Firebase is passed

callback - PCKYCManager.SessionCallback to handle results

startSession

public static void startSession(java.lang.String KYCConnectorUrl,
                                java.lang.String systemId,
                                java.lang.String appExtra,
                                java.lang.String pushId,
                                PCPushServiceType pushServiceType,
                                PCKYCManager.SessionCallback callback)

Starts session to interact with KYC-Connector. PCKYCSession object is returned through callback in case of success
Includes following steps:
(1) Key pair generation (2) Registration of public key (3) Saving received session ID for further interaction (4) Saving session to Shared Preferences

Parameters:

KYCConnectorUrl - The URL of KYC connector service

appExtra - A valid JSON-string containing any required additional data

systemId - The identifier of the system or null

pushId - Firebase Push token to receive notifications, may be null

pushServiceType - Type of service to work with pushes. One of values from PCPushServiceType. May be null if pushId is null. If pushId is not null, passing null value for this param has the same impact as if PCPushServiceType.Firebase is passed

callback - PCKYCManager.SessionCallback to handle results

getSessionStatus

public static void getSessionStatus(PCKYCSession session,
                                    PCKYCManager.SessionStatusCallback callback)

Retrieves the current status of the session

Parameters:

callback - Callback for handling results

getStatusHistory

public static void getStatusHistory(PCKYCSession session,
                                    PCKYCManager.StatusHistoryCallback callback)

Retrieves the history of statuses for a particular session

Parameters:

callback - Callback for handling results

uploadMedia

public static void uploadMedia(PCKYCSession session,
                               byte[] data,
                               java.lang.String fileExtension,
                               PCKYCSession.MediaSourceType type,
                               PCKYCManager.UploadMediaCallback callback)

Uploads the media of specified type to the server in order to perform an analysis

Parameters:

session - Target PCKYCSession

data - Photo or video as array of bytes

fileExtension - File extension which is necessary for proper request. You may put null instead, then it is supposed that photos are in JPG format while the video are encoded in MP4. If you mention the actual format, please note that a dot (.) must be put first.

type - Type of data to be uploaded, must be one of PCKYCSession.MediaSourceType

callback - Callback for handling results

uploadMedia

public static void uploadMedia(PCKYCSession session,
                               java.io.InputStream data,
                               java.lang.String fileExtension,
                               PCKYCSession.MediaSourceType type,
                               PCKYCManager.UploadMediaCallback callback)

Uploads the media of specified type to the server in order to perform an analysis

Parameters:

session - Target PCKYCSession

data - Photo or video as InputStream

fileExtension - File extension which is necessary for proper request. You may put null instead, then it is supposed that photos are in JPG format while the video are encoded in MP4. If you mention the actual format, please note that a dot (.) must be put first.

type - Type of data to be uploaded, must be one of PCKYCSession.MediaSourceType

callback - Callback for handling results

uploadMedia

public static void uploadMedia(PCKYCSession session,
                               java.io.File data,
                               PCKYCSession.MediaSourceType type,
                               PCKYCManager.UploadMediaCallback callback)

Uploads the media of specified type to the server in order to perform an analysis

Parameters:

session - Target PCKYCSession

data - Photo or video as File object

type - Type of data to be uploaded, must be one of PCKYCSession.MediaSourceType

callback - Callback for handling results

uploadAllMedia

public static void uploadAllMedia(PCKYCSession session,
                                  java.util.HashMap<PCKYCSession.MediaSourceType,java.io.File> data,
                                  PCKYCManager.UploadMediaCallback callback)

Uploads all required media to the server in order to perform an analysis

Parameters:

session - Target PCKYCSession

data - HashMap with required data, where each key stands for one type among PCKYCSession.MediaSourceType and each value is File object representing data of corresponding type. This method just triggers series of calls of uploadMedia(PCKYCSession, File, PCKYCSession.MediaSourceType, PCKYCManager.UploadMediaCallback).

callback - Callback for handling results

getOCRResults

public static void getOCRResults(PCKYCSession session,
                                 PCKYCManager.OCRResultsCallback callback)

Gets results of OCR procedure. If OCR is done successfully, the results are returned as a raw string. Its content depends on the type of enabled analyser (which can be found out via PCKYCSession.getAnalyserType().

Parameters:

session - Target PCKYCSession

callback - Callback to handle results

getRequiredSources

public static void getRequiredSources(PCKYCSession session,
                                      PCKYCManager.RequiredSourcesCallback callback)

Gets required sources from server which must be uploaded again to succeed OCR

Parameters:

session - Target PCKYCSession

callback - Callback to handle results

approveOCRResults

public static void approveOCRResults(PCKYCSession session,
                                     PCKYCManager.HandleOCRResultsCallback callback)

Approves results of OCR. Supposed to be called after OCR is successful and user is shown the way their documents were processed (the list of recognised fields can be obtained via getOCRResults(PCKYCSession, OCRResultsCallback)).

Parameters:

session - Target PCKYCSession

callback - Callback to handle results

declineOCRResults

public static void declineOCRResults(PCKYCSession session,
                                     PCKYCManager.HandleOCRResultsCallback callback)

Declined results of OCR. Supposed to be called after OCR is successful and user is shown the way their documents were processed (the list of recognised fields can be obtained via getOCRResults(PCKYCSession, OCRResultsCallback)).

Parameters:

session - Target PCKYCSession

callback - Callback to handle results

getPCUser

public static void getPCUser(PCKYCSession session,
                             PCKYCManager.GetPCUserCallback callback)

Retrieves a PC key from server and returns PCUser object ready to be used in the app.
This function is supposed to be called only when the session reaches status PCKYCSession.SessionStatus.ANALYSED_SUCCESSFULLY

Parameters:

session - Target PCKYCSession

callback - Callback for handling results

storeSession

public static boolean storeSession(PCKYCSession session)

Stores session data in order to use later.
The session is stored automatically after successful execution of the following methods:

• startSession(String, String, PCPushServiceType, SessionCallback)
• getSessionStatus(PCKYCSession, SessionStatusCallback)
• uploadMedia(PCKYCSession, File, PCKYCSession.MediaSourceType, UploadMediaCallback)
• uploadMedia(PCKYCSession, InputStream, String, PCKYCSession.MediaSourceType, UploadMediaCallback)
• uploadMedia(PCKYCSession, byte[], String, PCKYCSession.MediaSourceType, UploadMediaCallback)
• uploadAllMedia(PCKYCSession, HashMap, UploadMediaCallback)
• getOCRResults(PCKYCSession, OCRResultsCallback)
• approveOCRResults(PCKYCSession, HandleOCRResultsCallback)
• declineOCRResults(PCKYCSession, HandleOCRResultsCallback)
• getPCUser(PCKYCSession, GetPCUserCallback)

Returns:

True if session was stored successfully, otherwise false

closeSession

public static void closeSession(PCKYCSession session)

This function must be called after the PCUser acquired or after work with session is finished by another reason in order to delete session data from storage

Parameters:

session - Target PCKYCSession

listSessions

public static java.util.List<PCKYCSession> listSessions()

Restores all previously stored sessions and returns the list of PCKYCSession objects

Returns:

List of PCKYCSession objects which might be empty if no sessions are stored

deleteAllRestoredSessions

public static void deleteAllRestoredSessions()

Delete any existing sessions in storage