@idfy/sdk/dist/services/identification/IdentificationService.d.ts

Node.js SDK for Idfy REST API

import IdfyBaseService from '../IdfyBaseService';
import { CreateBankIDMobileRequest, CreateBankIDMobileResponse, CreateIdentificationRequest, CreateIdentificationResponse, IdentificationCompleteResponse, IdentificationLogItem, IdentificationResponse, LogItemList } from './';
/**
 * @deprecated Use IdentificationV2Service instead.
 */
export declare class IdentificationService extends IdfyBaseService {
    /**
     * Retrieves the response of a single identification session.
     * @param requestId
     * @param metaData
     */
    getSession(requestId: string, metaData?: boolean): Promise<IdentificationResponse>;
    /**
     * Creates a new identification session.
     * @param createIdentificationRequest
     */
    createSession(createIdentificationRequest: CreateIdentificationRequest): Promise<CreateIdentificationResponse>;
    /**
     * Retrieves the status of a single identification session.
     * @param requestId
     */
    getSessionStatus(requestId: string): Promise<IdentificationCompleteResponse>;
    /**
     * Invalidates an identification session to avoid using the same request twice.
     * @param requestId
     */
    invalidateSession(requestId: string): Promise<void>;
    /**
     * Gets an historic identification session (older than 14 days).
     * @param requestId
     */
    getLogEntry(requestId: string): Promise<IdentificationLogItem>;
    /**
     * Lists historic identification sessions filtered by the provided parameters.
     * @param year
     * @param month
     * @param day
     * @param status
     * @param identityProviderType
     * @param externalId
     * @param name
     * @param skip
     * @param pageSize
     */
    listLogEntries(year: number, month?: number, day?: number, status?: string, identityProviderType?: string, externalId?: string, name?: string, skip?: number, pageSize?: number): Promise<LogItemList>;
    /**
     * Creates a new Norwegian BankID mobile session to start the identification process.
     * @param createBankIdMobileRequest
     */
    createBankIdMobileSession(createBankIdMobileRequest: CreateBankIDMobileRequest): Promise<CreateBankIDMobileResponse>;
}