@bytexbyte/berifyme-react-sdk 1.0.0

package/dist/types/api/api.d.ts

@@ -0,0 +1,606 @@
+export declare enum DeveloperLogSource {
+    FRONTEND = 0,
+    BACKEND = 1
+}
+export declare enum ActionType {
+    ONBOARDING = 0,
+    LOGIN = 1
+}
+export interface User {
+    id: string;
+    isActive: boolean | null;
+    email: string | null;
+    phoneNumber: string | null;
+    authIDAccountNumber: string | null;
+    incodeId: string | null;
+    clearId: string | null;
+    sumsubId: string | null;
+    veriffId: string | null;
+    yotiId: string | null;
+    idmeId: string | null;
+    age: number | null | undefined;
+    birthDate: string | null | undefined;
+    fullName: string | null | undefined;
+}
+export type UserWithAgeAndFullName = User;
+export type UserWithCredentials = User & {
+    credentials: [] | undefined;
+};
+export interface CreatingUser {
+    id: string;
+    shortId: string;
+    verify: boolean;
+    email: string | null;
+    phoneNumber: string | null;
+}
+export interface Device {
+    id: string;
+    userId: string;
+    deviceId: string;
+    createdAt: Date;
+    expires: Date;
+}
+export type IdDocSetType = 'APPLICANT_DATA' | 'IDENTITY' | 'IDENTITY2' | 'IDENTITY3' | 'IDENTITY4' | 'SELFIE' | 'SELFIE2' | 'PROOF_OF_RESIDENCE' | 'PROOF_OF_RESIDENCE2' | 'QUESTIONNAIRE' | 'PHONE_VERIFICATION' | 'EMAIL_VERIFICATION' | 'E_KYC';
+interface BerifymeApiConfig {
+    backendDomain: string;
+}
+export declare function initializeBerifymeApi(userConfig: BerifymeApiConfig): void;
+declare function getAuthIDToken(): Promise<{
+    token: string;
+}>;
+declare function getIdDocumentTypes({ token }: {
+    token: string;
+}): Promise<{
+    idTypes: {
+        Name: string;
+        Description: string;
+    }[];
+    error: undefined;
+} | {
+    idTypes: undefined;
+    error: string;
+}>;
+declare function createAccount({ token, userId }: {
+    token: string;
+    userId: string;
+}): Promise<{
+    success: "ok";
+    error: undefined;
+    isAllSet: undefined;
+    details: undefined;
+} | {
+    success: undefined;
+    error: undefined;
+    isAllSet: boolean;
+    details: {
+        userId: string;
+        fullName: string;
+        phoneNumber: string;
+    };
+}>;
+declare function checkBiometricExist({ token, userId }: {
+    token: string;
+    userId: string;
+}): Promise<{
+    isExist: boolean;
+    error?: string;
+}>;
+declare function proofUser({ token, userId, idType }: {
+    token: string;
+    userId: string;
+    idType: string;
+}): Promise<{
+    OperationId: string;
+    OneTimeSecret: string;
+    url: string;
+}>;
+declare function getProofTransactionStatus({ token, operationId, userId }: {
+    token: string;
+    operationId: string;
+    userId: string;
+}): Promise<{
+    status: number | null;
+    error: undefined;
+} | {
+    status: undefined;
+    error: string;
+}>;
+declare function getProofTransactionTempId({ token, operationId, userId }: {
+    token: string;
+    operationId: string;
+    userId: string;
+}): Promise<{
+    TempId: string | null;
+    error: undefined;
+} | {
+    TempId: undefined;
+    error: string;
+}>;
+declare function createBiometricFromProof({ token, tempId, userId }: {
+    token: string;
+    tempId: string;
+    userId: string;
+}): Promise<{
+    success: "ok";
+    error: undefined;
+} | {
+    error: string;
+}>;
+declare function getAccount({ token, phone }: {
+    token: string;
+    phone: string;
+}): Promise<{
+    fullName: string;
+    dateOfBirth: string;
+    documentType: string;
+    issuingCountry: string;
+    gender: string;
+    dateOfExpiry: string;
+    error: undefined;
+} | {
+    fullName: undefined;
+    dateOfBirth: undefined;
+    documentType: undefined;
+    issuingCountry: undefined;
+    gender: undefined;
+    dateOfExpiry: undefined;
+    error: string;
+}>;
+declare function createLoginTransaction({ token, phone }: {
+    token: string;
+    phone: string;
+}): Promise<{
+    TransactionId: string;
+    OneTimeSecret: string;
+    url: string;
+    error: undefined;
+}>;
+declare function getTransactionStatus({ token, phone, transactionId }: {
+    token: string;
+    phone: string;
+    transactionId: string;
+}): Promise<{
+    userId: string;
+    operationId: string;
+    error?: string;
+}>;
+declare function getOperationStatus({ token, operationId }: {
+    token: string;
+    operationId: string;
+}): Promise<{
+    success: string;
+    error?: string;
+}>;
+declare function searchUser({ token, operationId }: {
+    token: string;
+    operationId: string;
+}): Promise<{
+    userId: string;
+    operationId: string;
+    error: undefined;
+}>;
+declare function getDocumentDetails({ token, operationId, userId }: {
+    token: string;
+    operationId: string;
+    userId: string;
+}): Promise<{
+    details: {
+        Key: string;
+        Value: string;
+    }[];
+    phone: string;
+    error: undefined;
+} | {
+    details: undefined;
+    phone: undefined;
+    error: string;
+}>;
+declare function updateAccount(token: string, data: {
+    phone: string;
+    fullName: string;
+    dateOfBirth: string;
+    documentType: string;
+    issuingCountry: string;
+    gender: string;
+    dateOfExpiry: string;
+}): Promise<{
+    success: "ok";
+}>;
+declare function getIncodeStart(uniqueId?: string): Promise<{
+    token: string;
+    uniqueId: string;
+}>;
+declare function getIncodeFinish({ token }: {
+    token: string;
+}): Promise<{
+    token: string;
+    uniqueId: string;
+}>;
+declare function getIncodeApprove({ id, token, uniqueId, }: {
+    id: string;
+    token: string;
+    uniqueId: string;
+}): Promise<{
+    incodeId?: string;
+    error?: string;
+}>;
+declare function createVerificationSession({ redirectUrl, token }: {
+    redirectUrl: string;
+    token?: string;
+}): Promise<{
+    sessionId: string;
+    token: string;
+}>;
+declare function getClearApprove({ id, sessionId, }: {
+    id: string;
+    sessionId: string;
+}): Promise<{
+    clearId?: string;
+    error?: string;
+}>;
+declare function createIdmeVerificationUrl({ redirectUrl, token }: {
+    redirectUrl: string;
+    token?: string;
+}): Promise<{
+    url?: string;
+    error?: string;
+}>;
+declare function sendIdmePhoneNumberVerify({ phoneNumber, idmeId, token }: {
+    phoneNumber: string;
+    idmeId?: string;
+    token?: string;
+}): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+declare function updateIdmeId({ id, idmeId, token }: {
+    id: string;
+    idmeId?: string;
+    token?: string;
+}): Promise<{
+    user: User;
+    error?: string;
+}>;
+declare function getIdmeApprove({ id, code, redirectUrl, }: {
+    id: string;
+    code: string;
+    redirectUrl: string;
+}): Promise<{
+    user?: UserWithAgeAndFullName;
+    error?: string;
+}>;
+declare function checkThirdPartyVerificationToken(token: string): Promise<{
+    success: boolean;
+    companyLogo?: string | null;
+    companyName?: string | null;
+    error?: string;
+}>;
+declare function sendVerifyEmail(email: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+declare function sendPhoneNumberVerify({ phoneNumber, token, domain }: {
+    phoneNumber: string;
+    token?: string;
+    domain?: string;
+}): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+declare function sendPhoneNumberCode({ phoneNumber, token }: {
+    phoneNumber: string;
+    token?: string;
+}): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+declare function verify(id: string): Promise<{
+    userId?: string;
+    error?: string;
+}>;
+declare function getUserBySessionId(sessionId: string): Promise<{
+    user?: UserWithAgeAndFullName;
+    error?: string;
+}>;
+declare function getUserByCode(code: string, redirectUrl: string): Promise<{
+    user?: UserWithAgeAndFullName;
+    idmeId?: string;
+    error?: string;
+}>;
+declare function getUserByIncodeId(incodeId: string): Promise<{
+    user?: UserWithAgeAndFullName;
+    error?: string;
+}>;
+declare function getUserByClearId(clearId: string): Promise<{
+    user?: UserWithAgeAndFullName;
+    error?: string;
+}>;
+declare function getUserVenderByPhone({ phoneNumber }: {
+    phoneNumber: string;
+}): Promise<{
+    vender?: string | null;
+    fullName?: string | null;
+    error?: string;
+}>;
+declare function getUserByPhoneNumberAndVerifyCode({ phoneNumber, code }: {
+    phoneNumber: string;
+    code: string;
+}): Promise<{
+    user?: UserWithCredentials;
+    error?: string;
+}>;
+declare function uploadDeviceId({ id, deviceId }: {
+    id: string;
+    deviceId: string;
+}): Promise<{
+    device: Device;
+    error?: string;
+}>;
+declare function checkDeviceId({ phoneNumber, deviceId, token }: {
+    phoneNumber: string;
+    deviceId: string;
+    token: string;
+}): Promise<{
+    user?: User;
+    error?: string;
+}>;
+declare function checkBlockchainToken({ phoneNumber, blockchainTokenId, token }: {
+    phoneNumber: string;
+    blockchainTokenId: string;
+    token: string;
+}): Promise<{
+    user?: User;
+    error?: string;
+}>;
+declare function getRedirectUrl({ userId, token, desktopRedirectUrlId }: {
+    userId: string;
+    token: string;
+    desktopRedirectUrlId?: string;
+}): Promise<{
+    redirectUrl?: string;
+    heartbeatStopped?: boolean;
+    companyName?: string;
+    error?: string;
+}>;
+declare function initUpdateAdminTokenSchedule(): Promise<{
+    status: number;
+}>;
+declare function deleteUpdateAdminTokenSchedule(): Promise<{
+    status: number;
+}>;
+declare function generateAppleWalletPass({ id, fullName, birthDate }: {
+    id: string;
+    fullName: string;
+    birthDate: string;
+}): Promise<{
+    serialNumber: string;
+}>;
+declare function createSessionToken({ apiKeyId, secretKey, redirectUrl }: {
+    apiKeyId: string;
+    secretKey: string;
+    redirectUrl: string;
+}): Promise<any>;
+declare function createAuthenticationLogs({ actionType, token, userId, vender, os, browser, device, transactionId, incodeSessionId, clearSessionId, isPass, }: {
+    actionType: ActionType;
+    token: string;
+    userId: string;
+    vender: string;
+    os: string;
+    browser: string;
+    device: string;
+    transactionId?: string;
+    incodeSessionId?: string;
+    clearSessionId?: string;
+    isPass?: boolean;
+}): Promise<any>;
+declare function updateAuthenticationLogs({ isPass, transactionId, incodeSessionId, clearSessionId }: {
+    isPass: boolean;
+    transactionId?: string;
+    incodeSessionId?: string;
+    clearSessionId?: string;
+}): Promise<any>;
+declare function createDeveloperLog({ userId, sessionToken, action, firstDetail, secondDetail, userDataJson, source, browser, }: {
+    userId?: string;
+    sessionToken?: string;
+    action?: string;
+    firstDetail?: string;
+    secondDetail?: string;
+    userDataJson?: Record<string, any>;
+    source?: 'FRONTEND' | 'BACKEND';
+    browser?: string;
+}): Promise<any>;
+declare function checkAndIssueToken({ userId }: {
+    userId: string;
+}): Promise<any>;
+declare function getNFTToken({ phoneNumber }: {
+    phoneNumber: string;
+}): Promise<any>;
+declare function getWallet({ phoneNumber }: {
+    phoneNumber: string;
+}): Promise<any>;
+declare function createAccessToken({ phoneNumber, levelName }: {
+    phoneNumber: string;
+    levelName: 'basic-kyc-level' | 'face-login';
+}): Promise<{
+    token: string;
+    userId: string;
+} | {
+    error: string;
+}>;
+declare function approveUserByPhoneNumber({ phoneNumber }: {
+    phoneNumber: string;
+}): Promise<{
+    sumsubId: string;
+} | {
+    error: string;
+}>;
+declare function resetValidationStep({ sumsubId, idDocSetType }: {
+    sumsubId: string;
+    idDocSetType: IdDocSetType;
+}): Promise<{
+    success: 'ok';
+    error: string;
+}>;
+declare function getSumsubFaceLoginResult({ sumsubId, externalActionId }: {
+    sumsubId: string;
+    externalActionId: string;
+}): Promise<{
+    isVerified: boolean;
+} | {
+    error: string;
+}>;
+declare function getUserBySumsubId({ sumsubId }: {
+    sumsubId: string;
+}): Promise<{
+    user: UserWithAgeAndFullName;
+} | {
+    error: string;
+}>;
+declare function approveVeriffUserByPhoneNumber({ phoneNumber, sessionId }: {
+    phoneNumber: string;
+    sessionId: string;
+}): Promise<{
+    veriffId: string;
+} | {
+    error: string;
+}>;
+declare function getUserByVeriffId({ veriffId }: {
+    veriffId: string;
+}): Promise<{
+    user: UserWithAgeAndFullName;
+} | {
+    error: string;
+}>;
+declare function getVeriffFaceLoginResult({ sessionId }: {
+    sessionId: string;
+}): Promise<{
+    isVerified: boolean;
+} | {
+    error: string;
+}>;
+declare function getOrderByCountry({ countryCode }: {
+    countryCode: string;
+}): Promise<{
+    order?: [];
+    error?: string;
+}>;
+declare function createYotiSession({ phoneNumber }: {
+    phoneNumber: string;
+}): Promise<{
+    sessionId: string;
+    clientSessionToken: string;
+} | {
+    error: string;
+}>;
+declare function approveYotiUser({ sessionId }: {
+    sessionId: string;
+}): Promise<{
+    yotiId: string;
+} | {
+    error: string;
+}>;
+declare function getUserByYotiId({ yotiId }: {
+    yotiId: string;
+}): Promise<{
+    user: UserWithAgeAndFullName;
+} | {
+    error: string;
+}>;
+declare const berifymeApi: {
+    authID: {
+        getAuthIDToken: typeof getAuthIDToken;
+        getIdDocumentTypes: typeof getIdDocumentTypes;
+        createAccount: typeof createAccount;
+        checkBiometricExist: typeof checkBiometricExist;
+        proofUser: typeof proofUser;
+        getProofTransactionStatus: typeof getProofTransactionStatus;
+        getProofTransactionTempId: typeof getProofTransactionTempId;
+        createBiometricFromProof: typeof createBiometricFromProof;
+        getAccount: typeof getAccount;
+        createLoginTransaction: typeof createLoginTransaction;
+        getTransactionStatus: typeof getTransactionStatus;
+        getOperationStatus: typeof getOperationStatus;
+        searchUser: typeof searchUser;
+        getDocumentDetails: typeof getDocumentDetails;
+        updateAccount: typeof updateAccount;
+    };
+    incode: {
+        getIncodeStart: typeof getIncodeStart;
+        getIncodeFinish: typeof getIncodeFinish;
+        getIncodeApprove: typeof getIncodeApprove;
+    };
+    clear: {
+        createVerificationSession: typeof createVerificationSession;
+        getClearApprove: typeof getClearApprove;
+    };
+    idme: {
+        createIdmeVerificationUrl: typeof createIdmeVerificationUrl;
+        sendIdmePhoneNumberVerify: typeof sendIdmePhoneNumberVerify;
+        getIdmeApprove: typeof getIdmeApprove;
+        updateIdmeId: typeof updateIdmeId;
+    };
+    auth: {
+        sendVerifyEmail: typeof sendVerifyEmail;
+        sendPhoneNumberCode: typeof sendPhoneNumberCode;
+        sendPhoneNumberVerify: typeof sendPhoneNumberVerify;
+        verify: typeof verify;
+    };
+    user: {
+        getUserByCode: typeof getUserByCode;
+        getUserBySessionId: typeof getUserBySessionId;
+        getUserByIncodeId: typeof getUserByIncodeId;
+        getUserByClearId: typeof getUserByClearId;
+        getUserBySumsubId: typeof getUserBySumsubId;
+        getUserByYotiId: typeof getUserByYotiId;
+        getUserVenderByPhone: typeof getUserVenderByPhone;
+        getUserByPhoneNumberAndVerifyCode: typeof getUserByPhoneNumberAndVerifyCode;
+        uploadDeviceId: typeof uploadDeviceId;
+        checkDeviceId: typeof checkDeviceId;
+        checkBlockchainToken: typeof checkBlockchainToken;
+    };
+    thirdParty: {
+        getRedirectUrl: typeof getRedirectUrl;
+        checkThirdPartyVerificationToken: typeof checkThirdPartyVerificationToken;
+    };
+    scheduld: {
+        initUpdateAdminTokenSchedule: typeof initUpdateAdminTokenSchedule;
+        deleteUpdateAdminTokenSchedule: typeof deleteUpdateAdminTokenSchedule;
+    };
+    pass: {
+        generateAppleWalletPass: typeof generateAppleWalletPass;
+    };
+    tools: {
+        createSessionToken: typeof createSessionToken;
+    };
+    AuthenticationLogs: {
+        createAuthenticationLogs: typeof createAuthenticationLogs;
+        updateAuthenticationLogs: typeof updateAuthenticationLogs;
+    };
+    developerLogs: {
+        createDeveloperLog: typeof createDeveloperLog;
+    };
+    blockchain: {
+        checkAndIssueToken: typeof checkAndIssueToken;
+        getNFTToken: typeof getNFTToken;
+    };
+    wallet: {
+        getWallet: typeof getWallet;
+    };
+    sumsub: {
+        createAccessToken: typeof createAccessToken;
+        approveUserByPhoneNumber: typeof approveUserByPhoneNumber;
+        resetValidationStep: typeof resetValidationStep;
+        getSumsubFaceLoginResult: typeof getSumsubFaceLoginResult;
+    };
+    veriff: {
+        approveVeriffUserByPhoneNumber: typeof approveVeriffUserByPhoneNumber;
+        getUserByVeriffId: typeof getUserByVeriffId;
+        getVeriffFaceLoginResult: typeof getVeriffFaceLoginResult;
+    };
+    yoti: {
+        createYotiSession: typeof createYotiSession;
+        approveYotiUser: typeof approveYotiUser;
+    };
+    getOrderByCountry: typeof getOrderByCountry;
+};
+export default berifymeApi;

package/dist/types/api/client.d.ts

@@ -0,0 +1,2 @@
+declare const apiClient: import("axios").AxiosInstance;
+export default apiClient;

package/dist/types/api/index.d.ts

@@ -0,0 +1,16 @@
+export declare const getExampleData: () => Promise<any>;
+export declare const createTokenData: (body: {
+    apiKeyId: string;
+    secretKey: string;
+    redirectUrl: string;
+}) => Promise<any>;
+export declare const getUserDataByTokenData: ({ header, params, }: {
+    header: {
+        apiKeyId: string;
+        secretKey: string;
+    };
+    params: {
+        token: string;
+        fields: string;
+    };
+}) => Promise<any>;

package/dist/types/common.d.ts

@@ -0,0 +1,3 @@
+export declare const delay: (n: number) => Promise<unknown>;
+export declare const countryCodesToName: Record<string, string>;
+export declare function getCountryNameByCode(code: string): string;

package/dist/types/components/AllSet/index.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { User } from "../../api/api";
+declare const AllSet: ({ user, token, desktopRedirectUrlId }: {
+    user: User | undefined;
+    token: string | undefined;
+    desktopRedirectUrlId?: string;
+}) => React.JSX.Element;
+export default AllSet;

package/dist/types/components/AuthenticationLogs.d.ts

@@ -0,0 +1,19 @@
+import { ActionType } from "../api/api";
+interface AuthenticationLogInput {
+    userId: string;
+    vender: string;
+    token: string;
+    transactionId?: string;
+    incodeSessionId?: string;
+    clearSessionId?: string;
+    isPass?: boolean;
+    actionType: ActionType;
+}
+export declare const createAuthenticationLog: ({ userId, vender, token, transactionId, incodeSessionId, clearSessionId, isPass, actionType, }: AuthenticationLogInput) => Promise<void>;
+export declare const updateAuthenticationLog: ({ isPass, transactionId, incodeSessionId, clearSessionId }: {
+    isPass: boolean;
+    transactionId?: string;
+    incodeSessionId?: string;
+    clearSessionId?: string;
+}) => Promise<void>;
+export {};

package/dist/types/components/Clear.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { ActionType } from "../api/api";
+declare const Clear: ({ token, redirectUrl, userId, actionType }: {
+    token: string;
+    redirectUrl: string;
+    userId: string;
+    actionType: ActionType;
+}) => React.JSX.Element;
+export default Clear;

package/dist/types/components/Footer/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare const Footer: () => React.JSX.Element;
+export default Footer;

package/dist/types/components/Layout.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+declare const Layout: ({ children }: {
+    children: React.ReactNode;
+}) => React.JSX.Element;
+export default Layout;

package/dist/types/components/Login/authid/authid.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { UserWithAgeAndFullName } from "../../../api/api";
+declare const AuthID: ({ phone, setError, goRedirect, goToTryAgain, setUser, token }: {
+    phone: string;
+    setError: React.Dispatch<React.SetStateAction<string | undefined>>;
+    goRedirect: () => void;
+    goToTryAgain: () => void;
+    setUser: React.Dispatch<React.SetStateAction<UserWithAgeAndFullName | undefined>>;
+    token: string;
+}) => React.JSX.Element;
+export default AuthID;

package/dist/types/components/Login/authid/index.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { UserWithAgeAndFullName } from "../../../api/api";
+declare const AuthidLogin: React.FC<{
+    goToAllSet: () => void;
+    phoneNumber: string;
+    setUser: React.Dispatch<React.SetStateAction<UserWithAgeAndFullName | undefined>>;
+    token?: string;
+}>;
+export { AuthidLogin };