Captura de documentos

Versión 2.3.X

La captura de documentos se realiza con el SelphID Plugin.

Este componente se encarga de realizar capturas de documentos de identidad y del análisis de los datos obtenidos. Sus principales procesos son:

• Gestión interna de cámaras y permisos.

• Asistente en los procesos de captura de la parte frontal y trasera del documento.

• Extracción de la información contenida en el documento.

• Obtención de las imágenes del dorso y reverso del documento, así como otras imagénes incluidas en el documento: cara del usuario, firma del usuario,...

• Alto nivel de configuración: diferentes países, idiomas, tipos de documentos...

---

Dependencias

Cordova:

cordova plugin add @facephi/sdk-selphid-cordova@<versión>

Android - Gradle:

implementation "com.facephi.androidsdk:selphid_component:$version"

iOS - Cocoapods:

pod 'FPHISDKSelphIDComponent', '~> $version'

Métodos disponibles

Este componente contiene varios métodos que ejecutan diferentes funcionalidades:

Método	Descripción
launchSelphID	Controlador principal de captura de documentos

Método launchSelphID

Una vez iniciado el SDK y creada una nueva operación se podrá lanzar el componente. Se podrá hacer uso de cualquiera de sus controladores para ejecutar su funcionalidad.

Lanzamiento de la captura facial:

exports.launchSelphID = function (cfg) {
    return new Promise((resolve, reject) => {
        var config = [];
        try {
            config = [{ config_id: cfg }];
        } catch (e) {
            console.log(e);
        }

        exec(resolve, reject, 'SdkSelphid', 'launchSelphID', config);
    });
};

Configuración básica

Para lanzar el componente actual, se deberá crear un objeto SelphIDConfiguration que será la configuración del controlador del componente.

La configuración básica necesaria para es la siguiente:

export interface SelphIDConfiguration 
{
    wizardMode?: boolean;
    documentSide: SelphIDDocumentSide;
    resourcesPath: string;
    debug?: boolean;
    showResultAfterCapture?: boolean;
    showTutorial?: boolean;
    tutorialOnly?: boolean;
    scanMode?: SelphIDScanMode;
    specificData?: string;
    fullscreen?: number;
    tokenImageQuality?: number;
    documentType?: SelphIDDocumentType;
    timeout?: SelphIDTimeout;
    tokenPrevCaptureData?: string;
    generateRawImages?: boolean;
    imageQuality?: number;
    compressFormat?: SelphIDCompressFormat;
    documentModels?: string;
    params?: any;
    showDiagnostic?: boolean;
    cameraId?: number;
    translationsContent?: string;
    viewsContent?: string;
    showPreviousTip?: boolean;
    vibrationEnabled?: boolean;
}

Configuración avanzada del componente

A continuación se detallan todos los campos que forman parte de esta clase.

Selphid Configuración

---

Recepción del resultado

El lanzamiento devolverá la información en formato SelphIDResult. Pudiendo diferenciarse entre un lanzamiento correcto y uno incorrecto:

export interface SelphIDResult 
{
    finishStatus: number;
    finishStatusDescription: string;
    errorType: string;
    errorMessage?: string;
    frontDocumentImage?: string;
    backDocumentImage?: string;
    faceImage?: string;
    signatureImage?: string;
    fingerprintImage?: string;
    documentData?: string;
    tokenFrontDocument?: string;
    tokenBackDocument?: string;
    tokenFaceImage?: string;
    tokenOCR?: string;
    documentCaptured?: string;
    captureProgress: number;
    matchingSidesScore: number;
    rawFrontDocument?: string;
    rawBackDocument?: string;
    tokenRawFrontDocument?: string;
    tokenRawBackDocument?: string;
    lastActionBeforeCapture?: string;
}

Configuración avanzada del componente

A continuación se detallan todos los campos que forman parte de esta clase.

Selphid Resultado

Personalización del componente

Además de los cambios que se pueden realizar a nivel de SDK (los cuales se explican en el documento de Ajustes avanzados), este componente en concreto permite su propia personalización.

Selphid - Personalización del Componente