Skip to content

SDK Reference (iOS)

WideTechId - Mobile Team edited this page Oct 24, 2022 · 3 revisions

This wiki contains references for the iOS SDK

Contents


WKYCConstants

The WKYCConstants class is used to provide some constant values, which are used as keys for setting up the SDK input fields in all of the KYC processes.

Fields

Field name Data type Description
LOCALE String Standard clientConfig key that is used to represent active language, which is used by the WideKYC SDK. optional parameters of WKYCRequest Class.
UI_CONFIG_PATH String Standard clientConfig key that is used to represent the UI configuration file path.
PROCESSED_IMAGE_PATH String Standard WKYCResponse key that is used to represent processed image file path.
LANG_EN String Standard LOCALE key that is used to represent the English language.
LANG_ID String Standard LOCALE key that is used to represent the Indonesian language.
PRODUCT String Standard key that is used to represent the target product, which is used to initialize the WideKYC SDK.
TRX_ID String Standard WKYCResponse key that is used to represent the transaction id of the current process.
META_INFO String Standard key that is used to represent device meta info, which is used to initialize the WideKYC SDK.
SERVICE_LEVEL String Standard key that is used to represent service level, which is used to initialize the WideKYC SDK.
PASSIVE_LIVENESS String Standard key that is used to represent Passive Liveness product type:00.
ID_RECOGNIZE String Standard key that is used to represent ID Recognize product type:01.
ID_VALIDATION String Standard key that is used to represent ID Validation product type:02.
SL_PASSIVE_LIVENESS_MED String Standard key that is used to represent Passive Liveness Medium service level:62000.
SL_PASSIVE_LIVENESS_ADV String Standard key that is used to represent Passive Liveness Advanced service level:62001.
SL_ID_RECOGNIZE_ENT String Standard key that is used to represent ID Recognize Entry service level:62010.
SL_ID_RECOGNIZE_MED String Standard key that is used to represent ID Recognize Entry service level:62011.
SL_ID_RECOGNIZE_ADV String Standard key that is used to represent ID Recognize Entry service level:62012.
SL_ID_VALIDATION_UI String Standard key that is used to represent ID Validation UI service level:62020.
SL_ID_VALIDATION_API String Standard key that is used to represent ID Recognize API service level:62021.
ID_NIK String Standard key that is used to represent NIK, which is used by the WKYCID.
ID_NAME String Standard key that is used to represent Name, which is used by the WKYCID.
ID_BIRTHDATE String Standard key that is used to represent Birthdate, which is used by the WKYCID.
ID_BIRTHPLACE String Standard key that is used to represent Birthplace, which is used by the WKYCID.
ID_ADDRESS String Standard key that is used to represent Address, which is used by the WKYCID.
ID_MOTHER_NAME String Standard key that is used to represent Mother Name, which is used by the WKYCID.
ID_IMAGE String Standard key that is used to represent ID Image, which is used by the WKYCID.
PASSIVE_LIVENESS_IMAGE String Standard key that is used to represent Selfie Image, which is used by the WKYCID.

Methods

N/A


WKYC

This class provides static utility methods for generating meta information, and a helper to start WideKYC SDK.

Fields

N/A

Methods

1. getMetaInfo

Generates WideKYC SDK meta-information, which is used for server-side transaction initialization.

Returns

The WideKYC SDK meta information.

Throws

N/A

3. start

Launches the WideKYC SDK.

Parameters

Returns

N/A

Throws

N/A


WKYCRequest

This class is an abstract description of an operation to be performed, which can be used with WKYC class to launch the ZOLOZ SDK.

Fields

Methods

N/A


WKYCResponse

The result of the WideKYC SDK.

Fields

Methods

N/A


WKYCCallback

Fields

N/A

Methods

1. onComplete

This callback method is triggered after the WideKYC process is completed.

Parameters

Returns

N/A

Throws

N/A

2. onInterrupted

This callback method is triggered when there is an issue with the WideKYC process.

Returns

N/A

Throws

N/A

3. onCancel

This callback method is triggered when the user clicks Cancel to exit the SDK.

Parameters

Returns

N/A

Throws

N/A


WKYCID

This class provides a container for user ID information used on ID Validation Products.

Fields

Fields name Data type Description
nik String Specifies the NIK (Id Number) of the user ID.
name String Specifies the name (Id Number) of the user ID.
birthdate String Specifies the birthdate (Id Number) of the user ID.
birthplace String Specifies the birthplace (Id Number) of the user ID.
address String Specifies the address (Id Number) of the user ID.
motherName String Specifies the motherName (Id Number) of user ID.
faceCaptureImage String Specifies the captured photo of the user's face.

Methods