Captura de documentos - SelphID

Versão 2.3.X

A captura de documentos é realizada com o SelphID Plugin.

Este componente é responsável por realizar capturas de documentos de identidade e pela análise dos dados obtidos. Seus principais processos são:

• Gestão interna de câmeras e permissões.

• Assistente nos processos de captura da parte frontal e traseira do documento.

• Extração das informações contidas no documento.

• Obtenção das imagens do dorso e do verso do documento, assim como de outras imagens incluídas no documento: rosto do usuário, assinatura do usuário,...

• Alto nível de configuração: diferentes países, idiomas, tipos de documentos...

---

Dependências

Cordova:

Cordova Plugin add @facephi/sdk-selphid-cordova@<versão>

Android - Gradle:

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

iOS - CocoaPods:

pod 'FPHISDKSelphIDComponent', '~> $version'

Métodos disponíveis

Este componente contém vários métodos que executam diferentes funcionalidades:

Método	Descrição
launchSelphID	Controlador principal de captura de documentos

Método launchSelphID

Uma vez iniciado o SDK e criada uma nova operação, será possível lançar o componente. Será possível fazer uso de qualquer um de seus controladores para executar sua funcionalidade.

Lançamento da 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);
    });
};

Configuração básica

Para iniciar o componente atual, deverá ser criado um objeto SelphIDConfiguration que será a configuração do controlador do componente.

A configuração básica necessária é a seguinte:

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;
}

Configuração avançada do componente

A seguir, estão detalhados todos os campos que fazem parte desta classe.

SelphID Configuração

---

Recebimento do resultado

O lançamento devolverá as informações no formato SelphIDResult. Podendo diferenciar-se entre um lançamento correto e um incorreto:

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;
}

Configuração avançada do componente

A seguir, estão detalhados todos os campos que fazem parte desta classe.

Selphid Resultado

Personalização do componente

Além das alterações que podem ser feitas no nível do SDK (as quais são explicadas no documento de Configurações avançadas)

Selphid - Personalização do Componente