Constants

SdkResultValues

Values for an SDK result

SdkResultValues Definition

const SdkResultValues = {
  USER_SHARED_CREDENTIALS: 'USER_SHARED_CREDENTIALS',
  USER_OPTED_OUT: 'USER_OPTED_OUT',
  NO_CREDENTIALS_FOUND: 'NO_CREDENTIALS_FOUND',
  RISK_SCORE_TOO_HIGH: 'RISK_SCORE_TOO_HIGH',
  MAX_INPUT_ATTEMPTS_EXCEEDED: 'MAX_INPUT_ATTEMPTS_EXCEEDED',
  MAX_VERIFICATION_CODE_ATTEMPTS_EXCEEDED:
    'MAX_VERIFICATION_CODE_ATTEMPTS_EXCEEDED',
};

Example

Example Usage of SdkResultValues

import { SdkResultValues, SdkResult, ... } from '@verifiedinc-public/client-sdk';

function handleResult(data: SdkResult) {
    switch (data.type) {
        case SdkResultValues.USER_SHARED_CREDENTIALS: // Success!
            // Pass data.identityUuid to server (to call GET /1-click/{identityUuid})
        case SdkResultValues.USER_OPTED_OUT: // User clicked 'Sign Up Manually Instead'
            // Take user to manual signup flow
        case SdkResultValues.NO_CREDENTIALS_FOUND: // OCE013 Verified error code
            // Take user to manual signup flow. Additional metadata may be available.
        case SdkResultValues.RISK_SCORE_TOO_HIGH: // OCE017 Verified error code
            // Take user to manual signup flow. Additional metadata may be available.
        case SdkResultValues.MAX_INPUT_ATTEMPTS_EXCEEDED: // OCE019 Verified error code
            // Take user to manual signup flow. Additional metadata may be available.
        case SdkResultValues.MAX_VERIFICATION_CODE_ATTEMPTS_EXCEEDED: // User tried verification code too many times
            // Take user to manual signup flow. Additional metadata may be available.
    }
}

---

SdkErrorReasons

Reasons for an SDK error

SdkErrorReasons Definition

const SdkErrorReasons = {
  SESSION_TIMEOUT: 'SESSION_TIMEOUT',
  INVALID_SESSION_KEY: 'INVALID_SESSION_KEY',
  SHARE_CREDENTIALS_ERROR: 'SHARE_CREDENTIALS_ERROR',
};

Example

Example Usage of SdkErrorReasons

import { SdkErrorReasons, SdkError, ... } from '@verifiedinc-public/client-sdk';

function handleError(error: SdkError) {
    switch (error.reason) {
        case SdkErrorReasons.INVALID_SESSION_KEY:
            // Create new session key (call POST /sessionKey server side)
        case SdkErrorReasons.SESSION_TIMEOUT:
            // Create new session key (call POST /sessionKey server side)
            // Initalize new VerifiedClientSDK instance
        case SdkErrorReasons.SHARE_CREDENTIALS_ERROR:
            // Take user to manual signup flow
    }
}