cidaas-javascript-sdk 4.2.4 → 4.3.1

package/dist/verification-service/VerificationService.d.ts

@@ -0,0 +1,219 @@
+import { HTTPRequestHeader } from "../common/Common.model";
+import { AuthenticateMFARequest, CancelMFARequest, CheckVerificationTypeConfiguredRequest, ConfigureFriendlyNameRequest, ConfigureVerificationRequest, EnrollVerificationRequest, GetMFAListRequest, InitiateAccountVerificationRequest, InitiateEnrollmentRequest, InitiateMFARequest, InitiateVerificationRequest, VerifyAccountRequest } from "./VerificationService.model";
+/**
+   * To initiate the account verification, call **initiateAccountVerification()**. This will send verification code  email or sms or ivr based on the verificationMedium you mentioned.
+   * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/cgans5erj5alg-init-account-verification for more details.
+   * @example
+   * ```js
+   * cidaas.initiateAccountVerification({
+   *   verificationMedium: 'email',
+   *   requestId: 'your requestId',
+   *   processingType: ProcessingType.CODE,
+   *   email: 'your email'
+   * }).then(function (response) {
+   *   // the response will give you account verification details.
+   * }).catch(function(ex) {
+   *   // your failure code here
+   * });
+   * ```
+   */
+export declare function initiateAccountVerification(options: InitiateAccountVerificationRequest): void;
+/**
+ * To complete the verification, call **verifyAccount()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/r8h9mvavvw2e6-verify-account for more details.
+ * @example
+ * ```js
+ * cidaas.verifyAccount({
+ *   accvid: 'your accvid', // which you will get on initiate account verification response
+ *   code: 'your code in email or sms or ivr'
+ * }).then(function (response) {
+ *   // the response will give you account verification ID and unique code.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To get all configured multi factor authentication, call **getMFAList()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
+ * @example
+ * ```js
+ * cidaas.getMFAList({
+ *   request_id: 'your request id',
+ *   email: 'your email'
+ * }).then(function (response) {
+ *   // the response will give you list of configured multi factor authentication
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getMFAList(options: GetMFAListRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * to cancel mfa process, call **cancelMFA()**.
+ * @example
+ * ```js
+ * cidaas.cancelMFA({
+ *   exchange_id: 'exchange id from initiateMFA() response',
+ *   reason: 'reason of mfa cancelation',
+ *   type: 'authentication type e.g. email'
+ * }).then(function (response) {
+ *   // your success code here
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function cancelMFA(options: CancelMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To get list of all verification type configured, call **getAllVerificationList()**. access_token must be passed as function parameter.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ *
+ * cidaas.getAllVerificationList(access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getAllVerificationList(access_token: string, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To initiate enrollment of new multi factor authentication, call **initiateEnrollment()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/f85aef6754714-initiate-physical-verification-setup for more details.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ * const options = {
+ *   verification_type: 'one of verification_type such as fido2, face, ivr',
+ *   deviceInfo: {
+ *    deviceId: '',
+ *    location: {lat: '', lon: ''}
+ *  }
+ * }
+ *
+ * cidaas.initiateEnrollment(options, access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function initiateEnrollment(options: InitiateEnrollmentRequest, accessToken: string): Promise<any>;
+/**
+ * to get the status of MFA enrollment, call **getEnrollmentStatus()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/b06447d02d8e0-get-status-of-physical-verification-setup-configuration for more details.
+ * @example
+ * ```js
+ * cidaas.getEnrollmentStatus('statusId from initiateEnrollment()', 'your access token')
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+*/
+export declare function getEnrollmentStatus(status_id: string, accessToken: string, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * to finish enrollment process of new multi factor authentication, call **enrollVerification()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/20ec76e937b27-enroll-physical-verification-setup for more details.
+ * @example
+ * ```js
+ * const fidoPayload = {
+ *   sub: 'your sub',
+ *   exchange_id: 'exchange_id from initiateEnrollment()',
+ *   verification_type: 'fido2',
+ *   fido2_client_response: {
+ *     client_response: 'client_response from doing fido process',
+ *     fidoRequestId: 'fidoRequestId from initiateEnrollment',
+ *   }
+ * }
+ * cidaas.enrollVerification(fidoPayload)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function enrollVerification(options: EnrollVerificationRequest): Promise<any>;
+/**
+ * to see details of configured verification type, call **checkVerificationTypeConfigured()**.
+ * @example
+ * ```js
+ * cidaas.checkVerificationTypeConfigured({
+ *   request_id: 'your request id',
+ *   email: 'your email',
+ *   verification_type: 'email'
+ * }).then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function checkVerificationTypeConfigured(options: CheckVerificationTypeConfiguredRequest): Promise<any>;
+/**
+ * to initiate multi factor auhentication, call **initiateMFA()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a3ea581bb249-initiate-verification for more details.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ * const options = {
+ *   request_id: 'your request id',
+ *   usage_type: 'PASSWORDLESS_AUTHENTICATION',
+ *   type: 'email'
+ *   email: 'your email'
+ *  }
+ * }
+ *
+ * cidaas.initiateMFA(options, access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function initiateMFA(options: InitiateMFARequest, accessToken?: string, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * to authenticate with multi factor auhentication, call **authenticateMFA()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/1aa38936252d6-perform-the-authentication-method for more details.
+  * @example
+  * ```js
+  * cidaas.authenticateMFA({
+  *   type: 'email',
+  *   client_id: 'your client id',
+  *   exchange_id: exchange id from initiateMFA(),
+  *   pass_code: 'code to authenticate'
+  * }).then(function (response) {
+  *   // type your code here
+  * })
+  * .catch(function (ex) {
+  *   // your failure code here
+  * });
+  * ```
+  */
+export declare function authenticateMFA(options: AuthenticateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * to initiate verification process, call **initiateVerification**
+ */
+export declare function initiateVerification(options: InitiateVerificationRequest, trackId: string, method: string): Promise<any>;
+/**
+ * to finish configuring verification process, call **configureVerification**
+ */
+export declare function configureVerification(options: ConfigureVerificationRequest, method: string): Promise<any>;
+/**
+ * to configure friendly name, call **configureFriendlyName**
+ */
+export declare function configureFriendlyName(options: ConfigureFriendlyNameRequest, trackId: string, method: string): Promise<any>;

package/dist/verification-service/VerificationService.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureFriendlyName = exports.configureVerification = exports.initiateVerification = exports.authenticateMFA = exports.initiateMFA = exports.checkVerificationTypeConfigured = exports.enrollVerification = exports.getEnrollmentStatus = exports.initiateEnrollment = exports.getAllVerificationList = exports.cancelMFA = exports.getMFAList = exports.verifyAccount = exports.initiateAccountVerification = void 0;
+const Helper_1 = require("../common/Helper");
+/**
+   * To initiate the account verification, call **initiateAccountVerification()**. This will send verification code  email or sms or ivr based on the verificationMedium you mentioned.
+   * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/cgans5erj5alg-init-account-verification for more details.
+   * @example
+   * ```js
+   * cidaas.initiateAccountVerification({
+   *   verificationMedium: 'email',
+   *   requestId: 'your requestId',
+   *   processingType: ProcessingType.CODE,
+   *   email: 'your email'
+   * }).then(function (response) {
+   *   // the response will give you account verification details.
+   * }).catch(function(ex) {
+   *   // your failure code here
+   * });
+   * ```
+   */
+function initiateAccountVerification(options) {
+    try {
+        const url = window.webAuthSettings.authority + "/verification-srv/account/initiate";
+        const form = Helper_1.Helper.createForm(url, options);
+        document.body.appendChild(form);
+        form.submit();
+    }
+    catch (ex) {
+        throw new Helper_1.CustomException(String(ex), 417);
+    }
+}
+exports.initiateAccountVerification = initiateAccountVerification;
+/**
+ * To complete the verification, call **verifyAccount()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/r8h9mvavvw2e6-verify-account for more details.
+ * @example
+ * ```js
+ * cidaas.verifyAccount({
+ *   accvid: 'your accvid', // which you will get on initiate account verification response
+ *   code: 'your code in email or sms or ivr'
+ * }).then(function (response) {
+ *   // the response will give you account verification ID and unique code.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function verifyAccount(options, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/account/verify";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+}
+exports.verifyAccount = verifyAccount;
+/**
+ * To get all configured multi factor authentication, call **getMFAList()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
+ * @example
+ * ```js
+ * cidaas.getMFAList({
+ *   request_id: 'your request id',
+ *   email: 'your email'
+ * }).then(function (response) {
+ *   // the response will give you list of configured multi factor authentication
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getMFAList(options, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/list";
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+}
+exports.getMFAList = getMFAList;
+/**
+ * to cancel mfa process, call **cancelMFA()**.
+ * @example
+ * ```js
+ * cidaas.cancelMFA({
+ *   exchange_id: 'exchange id from initiateMFA() response',
+ *   reason: 'reason of mfa cancelation',
+ *   type: 'authentication type e.g. email'
+ * }).then(function (response) {
+ *   // your success code here
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function cancelMFA(options, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/cancel/" + options.type;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", undefined, headers);
+}
+exports.cancelMFA = cancelMFA;
+/**
+ * To get list of all verification type configured, call **getAllVerificationList()**. access_token must be passed as function parameter.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ *
+ * cidaas.getAllVerificationList(access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function getAllVerificationList(access_token, headers) {
+    const _serviceURL = `${window.webAuthSettings.authority}/verification-srv/config/list`;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", access_token, headers);
+}
+exports.getAllVerificationList = getAllVerificationList;
+/**
+ * To initiate enrollment of new multi factor authentication, call **initiateEnrollment()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/f85aef6754714-initiate-physical-verification-setup for more details.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ * const options = {
+ *   verification_type: 'one of verification_type such as fido2, face, ivr',
+ *   deviceInfo: {
+ *    deviceId: '',
+ *    location: {lat: '', lon: ''}
+ *  }
+ * }
+ *
+ * cidaas.initiateEnrollment(options, access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function initiateEnrollment(options, accessToken) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/initiate/" + options.verification_type;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", accessToken);
+}
+exports.initiateEnrollment = initiateEnrollment;
+/**
+ * to get the status of MFA enrollment, call **getEnrollmentStatus()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/b06447d02d8e0-get-status-of-physical-verification-setup-configuration for more details.
+ * @example
+ * ```js
+ * cidaas.getEnrollmentStatus('statusId from initiateEnrollment()', 'your access token')
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+*/
+function getEnrollmentStatus(status_id, accessToken, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/notification/status/" + status_id;
+    return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST", accessToken, headers);
+}
+exports.getEnrollmentStatus = getEnrollmentStatus;
+/**
+ * to finish enrollment process of new multi factor authentication, call **enrollVerification()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/20ec76e937b27-enroll-physical-verification-setup for more details.
+ * @example
+ * ```js
+ * const fidoPayload = {
+ *   sub: 'your sub',
+ *   exchange_id: 'exchange_id from initiateEnrollment()',
+ *   verification_type: 'fido2',
+ *   fido2_client_response: {
+ *     client_response: 'client_response from doing fido process',
+ *     fidoRequestId: 'fidoRequestId from initiateEnrollment',
+ *   }
+ * }
+ * cidaas.enrollVerification(fidoPayload)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function enrollVerification(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/enroll/" + options.verification_type;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+}
+exports.enrollVerification = enrollVerification;
+/**
+ * to see details of configured verification type, call **checkVerificationTypeConfigured()**.
+ * @example
+ * ```js
+ * cidaas.checkVerificationTypeConfigured({
+ *   request_id: 'your request id',
+ *   email: 'your email',
+ *   verification_type: 'email'
+ * }).then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function checkVerificationTypeConfigured(options) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/check/" + options.verification_type;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
+}
+exports.checkVerificationTypeConfigured = checkVerificationTypeConfigured;
+/**
+ * to initiate multi factor auhentication, call **initiateMFA()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a3ea581bb249-initiate-verification for more details.
+ * @example
+ * ```js
+ * const access_token = "your access token";
+ * const options = {
+ *   request_id: 'your request id',
+ *   usage_type: 'PASSWORDLESS_AUTHENTICATION',
+ *   type: 'email'
+ *   email: 'your email'
+ *  }
+ * }
+ *
+ * cidaas.initiateMFA(options, access_token)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+function initiateMFA(options, accessToken, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/initiate/" + options.type;
+    // BREAKING TODO: remove accessToken parameter in the next major release
+    if (accessToken) {
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken, headers);
+    }
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", undefined, headers);
+}
+exports.initiateMFA = initiateMFA;
+/**
+ * to authenticate with multi factor auhentication, call **authenticateMFA()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/1aa38936252d6-perform-the-authentication-method for more details.
+  * @example
+  * ```js
+  * cidaas.authenticateMFA({
+  *   type: 'email',
+  *   client_id: 'your client id',
+  *   exchange_id: exchange id from initiateMFA(),
+  *   pass_code: 'code to authenticate'
+  * }).then(function (response) {
+  *   // type your code here
+  * })
+  * .catch(function (ex) {
+  *   // your failure code here
+  * });
+  * ```
+  */
+function authenticateMFA(options, headers) {
+    const _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/authenticate/" + options.type;
+    return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", undefined, headers);
+}
+exports.authenticateMFA = authenticateMFA;
+/**
+ * to initiate verification process, call **initiateVerification**
+ */
+function initiateVerification(options, trackId, method) {
+    const serviceURL = window.webAuthSettings.authority + '/verification-actions-srv/setup/' + method + '/initiate/' + trackId;
+    return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, 'POST');
+}
+exports.initiateVerification = initiateVerification;
+/**
+ * to finish configuring verification process, call **configureVerification**
+ */
+function configureVerification(options, method) {
+    const serviceURL = window.webAuthSettings.authority + '/verification-actions-srv/setup/' + method + '/verification';
+    return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, 'POST');
+}
+exports.configureVerification = configureVerification;
+/**
+ * to configure friendly name, call **configureFriendlyName**
+ */
+function configureFriendlyName(options, trackId, method) {
+    const serviceURL = window.webAuthSettings.authority + '/verification-actions-srv/setup/users/friendlyname/' + method.toUpperCase() + '/' + trackId;
+    return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, 'PUT');
+}
+exports.configureFriendlyName = configureFriendlyName;

package/dist/verification-service/VerificationService.model.d.ts

@@ -0,0 +1,158 @@
+import { ProcessingType } from "../common/Common.model";
+export interface InitiateAccountVerificationRequest {
+    /** email of user */
+    email?: string;
+    /** mobile number of user */
+    mobile?: string;
+    /** phone number of user */
+    phone?: string;
+    /** username of user */
+    username?: string;
+    /** described which medium (email, mobile, username) to be used for verifying user */
+    verificationMedium?: string;
+    /**
+     * can be either CODE, LINK, or GENERAL
+     * BREAKING TODO: change type to ProcessingType only in next major version
+     * */
+    processingType?: ProcessingType | string;
+    /** Request id returned from the authorization call */
+    requestId?: string;
+    /** Unique identifier of client app, can be found in app setting under admin ui */
+    client_id?: string;
+    /** Specify the url where the user needs to be redirected after successful login */
+    redirect_uri?: string;
+    /** response type expected for the process */
+    response_type?: string;
+    /** Subject (User) identifier */
+    sub?: string;
+    /** Refers to a template or predefined message/key associated with the opt-in reminder. */
+    templateKey?: string;
+    /** name of user */
+    name?: string;
+    /** Response language, which is configured in cidaas admin ui */
+    accept_language?: string;
+}
+export interface VerifyAccountRequest {
+    /** accvid will be given after initiate account verification process */
+    accvid: string;
+    /** code which has been sent to predetermined verification medium */
+    code: string;
+}
+export interface GetMFAListRequest {
+    /** email of user */
+    email: string;
+    /** Request id returned from the authorization call */
+    request_id: string;
+}
+export interface CancelMFARequest {
+    /** comes from initiate MFA process */
+    exchange_id: string;
+    /** reason of cancellation */
+    reason: string;
+    /** MFA type */
+    type: string;
+}
+export interface InitiateEnrollmentRequest {
+    /** type of MFA to be used for verification */
+    verification_type: string;
+    /** details of the device */
+    deviceInfo?: DeviceInfo;
+}
+export interface EnrollVerificationRequest {
+    /** subject (User) identifier */
+    sub?: string;
+    /** comes from initiate MFA process */
+    exchange_id?: string;
+    /** type of MFA to be used for verification  */
+    verification_type?: string;
+    /** the message that a client sends to a server after successfully authenticating a user using public key cryptography */
+    fido2_client_response?: FIDO2EnrollEntity;
+    /** id of the device */
+    device_id?: string;
+    /** unique identifier of client app, can be found in app setting under admin ui */
+    client_id?: string;
+    /** code to authenticae */
+    pass_code?: string;
+}
+export interface CheckVerificationTypeConfiguredRequest extends GetMFAListRequest {
+    /** type of MFA to be used for verification  */
+    verification_type: string;
+}
+export interface InitiateMFARequest {
+    /** user subject identifier */
+    sub?: string;
+    /** user email */
+    email?: string;
+    /** user mobile number */
+    mobile_number?: string;
+    /** application request id, generated by oauth call */
+    request_id?: string;
+    /** id for medium type (email, sms) */
+    medium_id?: string;
+    /** Type of authentication */
+    usage_type?: string;
+    /** medium type */
+    type?: string;
+    /** predetermined custom fields */
+    customFields?: {
+        [key: string]: string;
+    };
+}
+export interface AuthenticateMFARequest {
+    /** comes from initiate MFA process */
+    exchange_id: string;
+    /** code which has been sent to predetermined verification type */
+    pass_code: string;
+    /** type of MFA to be used for verification */
+    type: string;
+    /** Subject (User) identifier */
+    sub?: string;
+    /** id generated on Authz request */
+    requestId?: PerformanceServerTiming;
+}
+export interface DeviceInfo {
+    /** id of the device */
+    deviceId: string;
+    /** location details of the device */
+    location: Location;
+}
+export interface Location {
+    /** latitude of the device */
+    lat: string;
+    /** longitude of the device */
+    lon: string;
+}
+export interface FIDO2EnrollEntity {
+    /** details of client response */
+    client_response?: any;
+    /** unique identifier assigned to a FIDO2 authentication request. The value comes from initiate enrollment process */
+    fidoRequestId?: string;
+}
+export interface InitiateVerificationRequest {
+    /** mobile number */
+    mobile_number?: string;
+    /** phone number */
+    phone?: string;
+    /** email address */
+    email?: string;
+}
+export interface ConfigureVerificationRequest {
+    /** comes from initiate MFA process */
+    exchange_id: string;
+    /** subject (User) identifier */
+    sub: string;
+    /** code which has been sent to predetermined verification type */
+    pass_code: string;
+}
+export interface ConfigureFriendlyNameRequest {
+    /** id received from status verification API */
+    id?: string;
+    /** physical verification id received from status verification api */
+    ph_id?: string;
+    /** id recevied from enrollment API */
+    device_id?: string;
+    /** friendly name for the device */
+    friendly_name?: string;
+    /** subject (User) identifier */
+    sub?: string;
+}

package/dist/verification-service/VerificationService.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });