> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-en/sdks/sdk-mobile/framework-plugins/capacitor/componentes/componente-principal.md).

# Main component

It is the SDK's most important component, as it contains the libraries needed to ensure everything works correctly.

The installation of the **Core** **Plugin** is required, regardless of the products to be used and the defined use case. It contains basic functionality for the SDK to work, as well as other cross-cutting functionality required by the auxiliary plugins.

## Dependencies <a href="#id-2-dependencia" id="id-2-dependencia"></a>

### Capacitor:

```bash
npm i @facephi/sdk-core-capacitor@<versión>
npm run build
npx cap sync
```

### Android - Gradle:

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

### iOS - CocoaPods:

```swift
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 perform different functions:

<table data-header-hidden><thead><tr><th width="233.64453125"></th><th></th></tr></thead><tbody><tr><td><strong>Method</strong></td><td><strong>Description</strong></td></tr><tr><td>initSession</td><td>Main controller of the component, responsible for validating licenses, among other things.</td></tr><tr><td>initOperation</td><td>Method responsible for generating a new operation. Its ID is retrieved from the result object, in the data parameter.</td></tr><tr><td>getExtraData</td><td>The getExtraData method allows you to generate the identifiers required for an operation that must continue in the <em>Facephi Validation Service</em> (Backend).</td></tr><tr><td>closeSession</td><td>Before the application is destroyed, the SDK session must be closed to notify the platform that it has ended.</td></tr></tbody></table>

### initSession <a href="#id-2-inicializacion-de-la-sesion" id="id-2-inicializacion-de-la-sesion"></a>

Before you can use any component, you must initialize the SDK session. This initialization should be done as early as possible, preferably when the application starts. Likewise, once all operations with the SDK Mobile are complete, the session must be closed.

You can initialize the current component 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. Retrieving the license from a service via a URL and API key
* b. Injecting the license directly as a String

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

```javascript
initSession(configuration: InitSessionConfiguration): Promise<CoreResult>;
```

## Basic Configuration <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

To launch the current component, you must create an object ***InitSessionConfiguration*** which will be the component controller's configuration.

The basic configuration required is as follows:

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

### Advanced component configuration

All the fields that are part of this class are detailed below.

{% content-ref url="/pages/8de20a0612fefc3ed40ba226ed4e9e4d403555a7" %}
[Init Session Configuration](https://docs.facephi.com/docs.facephi-en/sdks/sdk-mobile/framework-plugins/extras/core/init-session-configuracion.md)
{% endcontent-ref %}

***

### initOperation <a href="#id-3-inicializacion-de-la-operacion" id="id-3-inicializacion-de-la-operacion"></a>

When starting a process or Flow, **always** the launchInitOperation method must be called

```javascript
initOperation(configuration: InitOperationConfiguration): Promise<CoreResult>;
```

## Basic Configuration <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

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

The basic configuration required is as follows:

```typescript
export interface InitOperationConfiguration {
    type: SdkOperationType;
    steps?: string[];
    customerId: string;
}
```

### Advanced component configuration

All the fields that are part of this class are detailed below.

{% content-ref url="/pages/927144262d70be7548c816dd23cee42db3620f0a" %}
[Init Operation Configuration](https://docs.facephi.com/docs.facephi-en/sdks/sdk-mobile/framework-plugins/extras/core/init-operation-configuracion.md)
{% endcontent-ref %}

***

### closeSession <a href="#id-6-cierre-de-sesion" id="id-6-cierre-de-sesion"></a>

Before the application is destroyed, the SDK session must be closed to notify the platform that it has ended. To do this, run the following code snippet:

```javascript
closeSession(): Promise<CoreResult>;
```

***

### launchGetExtraData <a href="#id-7-metodo-extradata" id="id-7-metodo-extradata"></a>

The getExtraData method generates the identifiers required for an operation that must continue in the *Facephi Validation Service* (Backend). This situation typically occurs when, after obtaining the necessary information in the client application, that information must be sent to a specific service for further validation or analysis. If the results of these processes need to be tracked on the Platform, it must be able to link the first part of the process, performed on the client, with the final part, performed by the service, since ultimately they are part of the same operation.

```javascript
getExtraData(): Promise<CoreResult>;
```

## Launching IDV <a href="#lanzamiento-de-idv" id="lanzamiento-de-idv"></a>

The IDV process launches a flow configured on the platform using its ID (flowID). To do this, you need to call two methods: **initFlow + startFlow**.

### launchInitFlow

In this method, set the required configuration: the ID of the flow configured on the platform (flowID) and the customer ID (customerID). See the code:

```dart
initFlow = async (): Promise<CoreResult> => 
{
  const widgetConfig: InitFlowConfiguration = {
    flow: "f40c098c-a878-4976-aef1-xxxxxxx",
    customerId: CUSTOMER_ID
  };
  return SdkCore.initFlow(widgetConfig);
};
```

```typescript
startFlow = async (): Promise<CoreResult> => 
{
  console.log('Launching startFlow...');
  return SdkCore.startFlow();
};
```

To configure the flow controller, create a list of the controllers for the components that will participate in the process, so they can be initialized correctly. The order in which they are defined does not matter; the flow itself determines the order in which they are executed. For example:

* **setSelphiFlow**: Face Capture
* **setSelphidFlow**: Document capture

Code to launch the flow:

```javascript
/* Results are received by implementing an addListener, with the key 'core.flow' */
listener: any = SdkCore.addListener('core.flow', (response: any) => 
{
  console.log("core.flow:", response);
});

await this.coreService.initFlow().then(async (result: CoreResult) => 
{
  if (result.finishStatus == SdkFinishStatus.Ok)
  {
    await this.selphiFaceService.setSelphiFlow()
      .then((res: SelphiFaceResult) => console.log("setSelphiFlow res", res))
      .catch((err) => console.log("setSelphiFlow err", err));
      
    await this.selphidService.setSelphidFlow()
      .then((res: SelphIDResult) => console.log("setSelphidFlow res", res))
      .catch((err) => console.log("setSelphidFlow err", err));


    await this.coreService.startFlow()
      .then((res: CoreResult) => console.log("startFlow res", res))
      .catch((err) => console.log("startFlow err", err));
  }
}, 
(err: any) => console.log(err));
```

## Receiving the result <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

All ***ALL*** methods will return information in CoreResult format. This makes it possible to distinguish between a successful launch and an unsuccessful one:

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

{% content-ref url="/pages/c2409d1f2884ad7ba323fd2108cc99568268a702" %}
[Core Result](https://docs.facephi.com/docs.facephi-en/sdks/sdk-mobile/framework-plugins/extras/core/core-resultado.md)
{% endcontent-ref %}
