### Query Documentation Example

Source: https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/identity-verification/nin-verify

This example demonstrates how to query the documentation dynamically using an HTTP GET request. Include your question as the value for the 'ask' query parameter.

```http
GET https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/identity-verification/nin-verify.md?ask=<question>
```

--------------------------------

### Making a GET Request with a Query Parameter

Source: https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/eventos

This example shows how to make a GET request to the documentation URL with an 'ask' query parameter to dynamically query the documentation. This is useful for retrieving specific information or clarifications not explicitly present on the page.

```http
GET https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/eventos.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/civil-registry/dha/crear-cliente

Perform an HTTP GET request to dynamically query documentation. Append the 'ask' query parameter with your question to the current page URL. The question should be specific and self-contained.

```http
GET https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/civil-registry/dha/crear-cliente.md?ask=<question>
```

--------------------------------

### Operation Started Webhook Example

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/webhook

An example JSON payload for the 'operation_started' webhook event, showing typical data fields like customerId, sessionId, and source.

```json
{
	"specversion": "1.0",
	"id": "4f65587f-2c4f-4ea2-b7ff-8fbf7d6fe8e8",
	"type": "com.idv_suite.api.workflows.operation_started.v1",
	"source": "/operations/5f2d2e8d-0f0f-4cae-8fc1-55756b6d06f3",
	"time": "2026-03-06T12:00:00.000Z",
	"data": {
		"customerId": "user-123",
		"sessionId": "sess-789",
		"source": "sdk.mobile"
	},
	"signature": "base64-hmac-signature"
}
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/company-verification/cac-search

To obtain additional information not explicitly present on the page, perform an HTTP GET request to the current URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/company-verification/cac-search.md?ask=<question>
```

--------------------------------

### Device Model Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the DEVICE_MODEL field, which stores the device model.

```json
"Chrome"
```

--------------------------------

### OS Name Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the OS_NAME field, which stores the operating system name.

```json
"114.0.0.0"
```

--------------------------------

### Configure Proxy Server for SDK Requests

Source: https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/propiedades/proxy

Use the `proxy` attribute to specify a proxy server for all SDK requests. Refer to the provided link for detailed setup instructions and examples.

```javascript
GET https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/propiedades/proxy.md?ask=<question>
```

--------------------------------

### Device Browser Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the DEVICE_BROWSER field, which stores the device browser.

```json
"Mac OS"
```

--------------------------------

### Install Landing SDK with NPM

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/instalacion

Install the SDK package using npm. This command adds the SDK to your project's dependencies.

```bash
npm install @facephi/landing-sdk
```

--------------------------------

### Authentication Status Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the authentication status.

```json
"POSITIVE"
```

--------------------------------

### Document Model Undefined Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example showing an undefined DOCUMENT_MODEL, which occurs when no document model is detected.

```json
undefined
```

--------------------------------

### Front Raw Base64 Image Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the full front frame of the document in base64 format. Can be empty if not provided or an error occurred.

```text
"/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1..."
```

```text
undefined
```

--------------------------------

### Example Usage with HTML Button (NPM)

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/instalacion

Integrate the Landing SDK into an HTML page, initializing it and triggering the landing page via a button click. Assumes local SDK build.

```html
<html>
  <script type="module">
    import LandingSDKClient from './dist/landing-sdk.js';
    const landingSDK = new LandingSDKClient('YOUR_APIKEY');

    const callLanding = () => {
      landingSDK.callLanding();
    }

    window.callLanding = callLanding;

  </script>
  <body>
    <div>
      Landing SDK Client
      <button onclick="callLanding()">Go to the landing page</button>
    </div>
  </body>
</html>
```

--------------------------------

### Examples of CLIENT_DATA

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Examples of client data, including a customer ID. This field can be empty if no session was started or if there was a problem during the session process.

```json
{
  "customerId": "0d8d7059"
}
```

```json
{}
```

--------------------------------

### Full SDK Loader Configuration Example

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/web-solution/sdk-loader-idv/configuracion-del-sdk

Demonstrates how to load the SDK with an API key, container ID, and customer ID. It also shows how to listen for SDK events after the SDK is loaded.

```typescript
import { loadSdk } from '@facephi/sdk-loader';

const sdkElement = await loadSdk({
  apiKey: 'YOUR_APIKEY',
  containerId: 'sdk-container',
  customerId: 'user-12345',
});

if (sdkElement) {
  // Listen to SDK events
  sdkElement.addEventListener('emitIDVIntegration', (event) => {
    console.log('Integration event:', event);
  });
}
```

--------------------------------

### Initialize the SDK with API Key

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/sdk-mobile/ios-sdk/inicializacion

Initialize the SDK controller with the provided licensing URL and API key. This setup grants access to all configured flows for the project. The output closure handles the result of the license acquisition.

```swift
SDKController.shared.initSdk(
        licensingUrl: SdkConfigurationManager.LICENSING_URL,
        apiKey: SdkConfigurationManager.APIKEY_LICENSING_IDV,
        output: { sdkResult in
            if sdkResult.finishStatus == .STATUS_OK {
                self.log("License automatically set correctly")
            } else {
                self.log("An error occurred while trying to obtain the license: \(sdkResult.errorType)")
            }
        },
        trackingController: trackingController,
        tokenizeController: tokenizeController,
        statusController: statusController,
        analyticsOutput: { time, component, type, info  in
            self.log("Analytics: \(Date()) \(component) - \(type) - \(info)")
        })

```

--------------------------------

### Video Provider Event Handling Example

Source: https://docs.facephi.com/sdks/sdk-web/componentes/video-recording-video-grabacion/eventos

Use this example to set up event listeners for extraction completion and exceptions. Ensure the handler functions are defined to process the event details and continue the onboarding process or log errors.

```jsx
<facephi-video-provider
    extractionFinish={handleExtractionFinish}
    exceptionCaptured={handleExceptionCaptured}
></facephi-video-provider>

<script>
function handleExtractionFinish(event) {
    const detail = event.detail.detail;
    console.log('FACEPHI SELPHID WIDGET DATA:', detail);
    // Continue process
    continueOnboarding();
}

function handleExceptionCaptured(event) {
    const detail = event.detail.detail;
    console.error('FACEPHI SELPHID WIDGET ERROR:', detail);
}
</script>
```

--------------------------------

### Example Usage with HTML Button (CDN)

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/instalacion

Integrate the Landing SDK into an HTML page using a CDN link, initializing it and triggering the landing page via a button click.

```html
<html>
  <script type="module">
    import LandingSDKClient from 'https://sdk-web.facephi.pro/landing-sdk/landing-sdk.js';
    const landingSDK = new LandingSDKClient('YOUR_APIKEY');

    const callLanding = () => {
      landingSDK.callLanding();
    }

    window.callLanding = callLanding;

  </script>
  <body>
    <div>
      Landing SDK Client
      <button onclick="callLanding()">Go to the landing page</button>
    </div>
  </body>
</html>
```

--------------------------------

### NodeJS Implementation for Unique URL Generation

Source: https://docs.facephi.com/api-rest/landing-api-reference/api-rest

Example of how to generate a unique landing page URL with a custom validity time using NodeJS and the fetch API. Ensure node-fetch is installed.

```javascript
const fetch = require('node-fetch');

const apiUrl = 'https://landing.identity-platform.io/api/landing';
const apiKey = 'YOUR_API_KEY';

const postData = {
    uniqueUrl: true,
    customerId: 'example',
    documentNumber: '1111111111S',
    time: '30'
};

fetch(apiUrl, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'x-api-key': apiKey
    },
    body: JSON.stringify(postData)
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Error');
    }
})
.then(data => {
    console.log('Response:', data);
})
.catch(error => {
    console.error('Error:', error);
});
```

--------------------------------

### Initialize and Call Landing SDK

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/metodos-disponibles

Initializes the Landing SDK client with an API key and launches the Landing process.

```javascript
const landingSDK = new LandingSDKClient('YOUR_APIKEY');

landingSDK.callLanding();
```

--------------------------------

### Document Validation Timestamp Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of a document validation timestamp.

```json
"1970-01-01T00:00:00.000Z"
```

--------------------------------

### Import and Initialize Landing SDK (NPM)

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/instalacion

Import the LandingSDKClient and initialize it with your API key after installation via NPM.

```javascript
import LandingSDKClient from '@facephi/landing-sdk';

const landingSDK = new LandingSDKClient('YOUR_APIKEY');
```

--------------------------------

### Querying Documentation via GET Request

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/formulario-embebido

To get additional information not present on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/formulario-embebido.md?ask=<question>
```

--------------------------------

### Start Onboarding Session

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/web-solution/no-code-landing

Initiates a verification session by generating an access URL. A unique operation identifier is returned upon successful session creation.

```json
{
  "operationId": "<uuid>"
}
```

--------------------------------

### Passive Liveness Result Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the result from a passive liveness check.

```json
"NO_LIVE"
```

--------------------------------

### SDK Provider Configuration Example

Source: https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/propiedades

Example of how to configure the SDK Provider component with various properties including API key, tracking steps, type, customer ID, and language.

```jsx
<facephi-sdk-provider
    apikey={process.env.FACEPHI_SDK_APIKEY}
    steps={`${TrackingSteps.START},${TrackingSteps.SELPHID_WIDGET},${TrackingSteps.SELPHI_WIDGET},${TrackingSteps.FINISH}`}
    type={TypeFamily.ONBOARDING}
    customerId={currentCustomerId}
    language={Language.en}
></facephi-sdk-provider>
```

--------------------------------

### Authentication Similarity Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the facial similarity score obtained during authentication.

```json
0.9923387765884399
```

```json
0.6823991719034381
```

--------------------------------

### Install SDK Web React

Source: https://docs.facephi.com/sdks/sdk-web/frameworks-y-samples

Install the SDK Web React library using npm. This command is used to add the necessary packages for React integration.

```bash
npm install @facephi/sdk-web-react
```

--------------------------------

### SDK Provider Usage Example

Source: https://docs.facephi.com/sdks/sdk-web/componentes/sdk-provider/metodos

This example shows how to integrate the SDK Provider component into an HTML page and access its methods using JavaScript. Ensure you replace 'YOUR_APIKEY' with your actual API key.

```html
<facephi-sdk-provider
  apikey="YOUR_APIKEY"
  steps="START,SELPHI_WIDGET,SELPHID_WIDGET,FINISH"
>
  </facephi-sdk-provider>

<script>
  const facephiSDKProvider = document.querySelector('facephi-sdk-provider');
  const operationId = facephiSDKProvider.getOperationId();
</script>
```

--------------------------------

### Example of TRANSACTION_ID

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

This is an example of a unique transaction ID, which is a mandatory field and cannot be empty.

```string
"00000000-0000-0000-0000-000000000000"
```

--------------------------------

### Environment Variable Setup

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/web-solution/sdk-loader-idv/integrations/nextjs

Create a .env file at the root of your project to store environment variables. Variables prefixed with NEXT_PUBLIC_ are exposed to the browser.

```bash
NEXT_PUBLIC_API_KEY=YOUR_API_KEY
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/banking-services/account-verify

To get additional information not present on the page, perform an HTTP GET request to the current URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/banking-services/account-verify.md?ask=<question>
```

--------------------------------

### Document Validation Type Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of a document validation type, indicating the status.

```json
"3"
```

--------------------------------

### Basic Integration Example

Source: https://docs.facephi.com/sdks/sdk-web/componentes/selphi-biometria-facial

Integrate the Selphi widget into your HTML. Configure language, disable tutorials, and handle completion events.

```jsx
<facephi-selphi-widget
  language="en"
  disableTutorial="false"
  onExtractionFinish={handleExtractionFinish}
></facephi-selphi-widget>

```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/civil-validation/peru

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/civil-validation/peru.md?ask=<question>
```

--------------------------------

### Run Development Server

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/web-solution/sdk-loader-idv/integracion

Start the development server for your application. The application will automatically reload on source file modifications.

```bash
npm run dev
```

--------------------------------

### Configure Podfile for SDK Integration

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/sdk-mobile/ios-sdk/instalacion

Set up your Podfile to use the private repository and include the FPHISDKMainComponent. The post_install script configures build settings for code signing.

```ruby
plugin 'cocoapods-art', :sources => [
  'cocoa-pro-fphi’
]

source 'https://cdn.cocoapods.org/'

target 'Example' do
  pod 'FPHISDKMainComponent', '~> $VERSION'

   post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['EXPANDED_CODE_SIGN_IDENTITY'] = ""
      config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
      config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
    end
  end
end
...
end
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.facephi.com/docs.facephi-en/products/autenticacion-usuarios-registrados/editor-1

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.facephi.com/docs.facephi-en/products/autenticacion-usuarios-registrados/editor-1.md?ask=<question>
```

--------------------------------

### Query Documentation via API

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/metodos-disponibles

Demonstrates how to query the documentation dynamically by making an HTTP GET request with an 'ask' query parameter.

```http
GET https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/metodos-disponibles.md?ask=<question>
```

--------------------------------

### Document Model Example

Source: https://docs.facephi.com/docs.facephi-en/products/landing/resultados-y-callbacks/datos-de-respuesta

Example of the DOCUMENT_MODEL field, indicating the detected model of an identity document.

```json
"CHILE - ID CARD (2013)"
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.facephi.com/sdks/sdk-mobile/framework-plugins/extras/nfc/nfc-configuracion

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.facephi.com/sdks/sdk-mobile/framework-plugins/extras/nfc/nfc-configuracion.md?ask=<question>
```

--------------------------------

### Example Request for Generated Video

Source: https://docs.facephi.com/sdks/sdk-web/componentes/video-recording-video-grabacion/resultados

This example demonstrates how to construct a URL using the video recording URL and operation ID, and then fetch the video data. The video blob is returned as a string. Be aware that requests made too soon after extraction may fail.

```javascript
const apiKey = process.env.VIDEO_PROVIDER_APIKEY; // Clave secreta proporcionada por el equipo de Facephi
const videoRecordingUrl = 'https://example.url'; // URL proporcionada por el equipo de Facephi
const operationId = 'operation-id-value'; // Valor obtenido del evento emitOperationId

function fetchVideo() {
  const url = `${videoRecordingUrl}/${operationId}`;

  fetch(url, {
    headers: {
      'x-api-key': apiKey,
    },
  })
    .then((response) => response.text())
    .then((data) => {
      console.log('Video generado:', data); // El blob de video grabado se proporcionará como una URL (string)
    });
}
```

--------------------------------

### Install VideoID Component with Cocoapods

Source: https://docs.facephi.com/sdks/sdk-mobile/ios-sdk/modulos/video-identificacion

Add the VideoID component dependency to your Podfile for installation via Cocoapods.

```ruby
pod 'FPHISDKVideoIDComponent', '~> $VERSION'
```

--------------------------------

### Install VideoID SDK for React Native

Source: https://docs.facephi.com/sdks/sdk-mobile/framework-plugins/react-native/componentes/video-id

Install the VideoID SDK for React Native using npm.

```APIDOC
## Installation

### React Native:

```swift
npm install @facephi/sdk-videoid-react-native@<version>
```
```

--------------------------------

### callLanding Method

Source: https://docs.facephi.com/docs.facephi-en/products/landing/metodos-de-integracion/landing-sdk/metodos-disponibles

Launches the Landing SDK by loading the SDK associated with the provided ApiKey. It can accept an options object to configure the execution.

```APIDOC
## callLanding

### Description
Launches the Landing SDK by loading the SDK associated with the provided ApiKey. This method can receive an object with one or more parameters to configure each execution.

### Method Signature
`callLanding(options?: object)`

### Parameters
#### Options Object
- **customerId** (string) - Optional - Associates the biometric operation with your client (e.g., email or user identifier).
- **documentNumber** (string) - Optional - The customer's identification number for comparison with biometric data.
- **callbackPath** (string) - Optional - Defines parameters to be added to the Callback URL for sending captured biometric data.
- **onFinish** (function) - Optional - An event handler that is triggered when the Flow ends (only available in iFrame implementation). It allows for additional logic to continue the Flow.

### Request Example (Basic)
```javascript
const landingSDK = new LandingSDKClient('YOUR_APIKEY');
landingSDK.callLanding();
```

### Request Example (With Options)
```javascript
landingSDK.callLanding({
  customerId: 'customer-id@example.com',
  documentNumber: '1234567A',
  callbackPath: 'https://url-callback-example.com/api/onboarding',
  onFinish: () => {
    // Continue process once the onboarding is finished.
    finishOnboarding();
  }
});
```
```

--------------------------------

### Install FPHISDKVideoRecordingComponent via CocoaPods

Source: https://docs.facephi.com/docs.facephi-en/products/idv-suite/flujos-and-integraciones/client-technical-configuration/sdk-mobile/ios-sdk/modulos/video-grabacion

Install the Selphi component by adding this entry to your application's Podfile.

```swift
pod 'FPHISDKVideoRecordingComponent', '~> $VERSION'
```

--------------------------------

### Instalar el Plugin Capacitor de Facephi

Source: https://docs.facephi.com/sdks/sdk-mobile/framework-plugins/capacitor/instalacion

Ejecuta estos comandos en tu terminal para instalar el plugin. Reemplaza `<versión>` con la última versión disponible y `<pluginName>` con el nombre del componente específico que necesitas.

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