@idfy/sdk/dist/services/identificationv2/IdentificationV2Service.d.ts

Node.js SDK for Idfy REST API

import IdfyBaseService from '../IdfyBaseService';
import { AppIdProvider, IdSession, IdSessionCreateOptions, LanguageDetails, PaginatedData } from './';
export declare class IdentificationV2Service extends IdfyBaseService {
    /**
     * Retrieves the details of a single identification session.
     * @param id
     */
    getSession(id: string): Promise<IdSession>;
    /**
     *  Returns a list of previously created sessions. The session data returned from this endpoint does not contain any personal information.
     * @param cursor
     * @param limit
     */
    listSessions(cursor?: string, limit?: number): Promise<PaginatedData<IdSession>>;
    /**
     * Creates a new identification session.
     * @param idSessionCreateOptions
     */
    createSession(idSessionCreateOptions: IdSessionCreateOptions): Promise<IdSession>;
    /**
     * Invalidates the specified identification session.
     * @param id
     */
    invalidateSession(id: string): Promise<void>;
    /**
     * Returns a list of supported languages.
     */
    listLanguages(): Promise<LanguageDetails>;
    /**
     * Returns a list of all the supported ID providers.
     */
    listIdProviders(): Promise<AppIdProvider>;
    /**
     * Returns a list of all the ID providers available for the requester's account.
     */
    listIdProvidersForAccount(): Promise<AppIdProvider>;
}