Main component

It is the most important component of the SDK, as it contains the libraries necessary for everything to work correctly.

The installation of the Core Plugin is mandatory, regardless of the products that need to be used and the use case that has been defined. It contains basic functionality for the operation of the SDK, as well as other cross-cutting and necessary functionality for the auxiliary plugins.

Dependencies

React Native:

npm i @facephi/sdk-core-react-native@<version>

Android - Gradle:

api "com.facephi.androidsdk:sdk:$version"
api "com.facephi.androidsdk:core:$version"
implementation "com.facephi.androidsdk:tracking_component:$version"

iOS - CocoaPods:

s.dependency 'FPHISDKMainComponent', '~> $version'
s.dependency 'FPHISDKTrackingComponent', '~> $version'
s.dependency 'FPHISDKLicensingComponent', '~> $version'
s.dependency 'FPHISDKTokenizeComponent', '~> $version'
s.dependency 'FPHISDKStatusComponent', '~> $version'

Available methods

This component contains several methods that execute different functionalities:

Method	Description
initSession	Main controller of the component, which is responsible for validating licenses, among other things.
initOperation	The method responsible for generating a new operation. Its id is retrieved in the result object, data parameter.
getExtraData	The getExtraData method allows generating the necessary identifiers for an operation that must continue in the Facephi Validation Service (Backend).
closeSession	Before the application is destroyed, the SDK session must be closed to notify the platform of its completion.

initSession

Before any component can be used, the SDK session must be initialized. This initialization should be done as soon as possible, preferably at the start of the application. At the same time, once all operations with the SDK Mobile have finished, the session must also be closed.

The current component can be initialized in two ways, depending on how you want to inject the license.

The new licensing method allows licenses to be managed transparently for the integrator. The license can be injected in two ways:

• a. Obtaining the license through a service via a URL and API-KEY

• b. Injecting the license directly as a String

In both cases, the result will be returned via a Promise, which contains an object of the class CoreResult.

export function initSession(config: InitSessionConfiguration): Promise<CoreResult> {
  return SdkCore.initSession(config);
}

Basic configuration

To launch the current component, an object InitSessionConfiguration must be created, which will be the configuration of the component controller.

The basic configuration needed for this is as follows:

export interface InitSessionConfiguration {
    license?: string;
    licenseUrl?: string;
    licenseApiKey?: string;
    enableTracking?: boolean;
    internalOptions?: Record<String, String>;
    enableDebugMode?: boolean;
    locale?: string;
}

Advanced component configuration

Below are all the fields that are part of this class.

Init Session Configuration

---

initOperation

When starting a process or flow, always the call to the launchInitOperation method must be made

export function initOperation(config: InitOperationConfiguration): Promise<CoreResult> {
  return SdkCore.initOperation(config);
}

Basic configuration

To launch the current component, an object InitOperationConfiguration must be created, which will be the configuration of the component controller.

The basic configuration needed for this is as follows:

export interface InitOperationConfiguration {
    type: SdkOperationType;
    customerId: string;
}

Advanced component configuration

Below are all the fields that are part of this class.

Init Operation Configuration

---

closeSession

Before the application is destroyed, the SDK session must be closed to notify the platform of its completion. To do this, the following code snippet is executed:

export function closeSession(): Promise<CoreResult> {
  return SdkCore.closeSession();
}

---

getExtraData

The getExtraData method allows generating the necessary identifiers for an operation that must continue in the Facephi Validation Service (Backend). This situation usually occurs in cases where, once the necessary information has been obtained in the client's application, that information must be sent to a certain service for later validation or analysis. If the results of those processes need to be tracked in the Platform, it must be able to unify the first part of the process performed on the client with the last part performed in the service, since in the end they are part of the same operation.

export function getExtraData(): Promise<CoreResult> {
  return SdkCore.getExtraData();
}

IDV Launch

The IDV process launches a flow configured in the platform from its ID (flowID). To do this, two methods must be called: initFlow + startFlow.

launchInitFlow

In this method, the necessary configuration will be set. The ID of the flow configured in the platform (flowID) and the client ID (customerID). See code:

export function initFlow(config: FlowConfiguration): Promise<CoreResult> {
  return SdkCore.initFlow(config);
}

To configure the flow controller, a list of the controllers for the components that will take part in the process will be created, which allows them to be initialized correctly. The order in which they are defined is not important; the flow itself will indicate the order in which they will be executed. For example:

• setSelphiFlow: Face Capture

• setSelphidFlow: Document Capture

Code for launching:

/* Los resultados se escuchan implementando un addListener, con el key 'core.flow' */
let flowListener = flowEmitter.addListener(
  "core.flow",
  (res: any) => console.log("FLOW_LISTENER", res)
);

const getFlowConfiguration = () => 
{
    const sdkConfiguration: FlowConfiguration = {
      flow: "f40c098c-a878-4976-aef1-xxxxxxx",
      customerId: CUSTOMER_ID,
    };
    return sdkConfiguration;
};
    
await initFlow(getFlowConfiguration())
.then(async (result: CoreResult) => 
{
  console.log("initFlow result", result);
  if (result.errorType == SdkErrorType.NoError) 
  {
    await setSelphiFlow().then((result: SelphiResult) => 
    {
      console.log("setSelphiFlow", result);
    });
    await setSelphidFlow().then((result: SelphidResult) => 
    {
      console.log("setSelphidFlow", result);
    });

    await startFlow()
    .then((result: CoreResult) => 
    {
      console.log("startFlow result", result);
    })
    .finally(()=> 
    {
      console.log("End startFlow...");
    });
  }
})
.finally(()=> {
  console.log("End launchFlow...");
});

Result reception

The launch of ALL the methods will return the information in CoreResult format. A distinction can be made between a successful launch and an unsuccessful one:

export interface CoreResult {
    finishStatus: number;
    finishStatusDescription?: string;
    errorType: string;
    errorMessage?: string;
    data?: string;
}

Core Result