Onboarding settings

Overview

The Onboarding Settings refer to all the configurations and steps that will be performed during the onboarding process for Smart Access. This configuration allows you to customize how different steps of the onboarding flow will be presented to the user, whether they are mandatory, optional, or can be skipped.

The following explains each of these elements and what they refer to in the configuration:

"onboardingSettings": {
  "steps": {
    "signUpForm": "mandatory",
    "basicInformation": "mandatory",
    "document": "mandatory",
    "liveness": "mandatory",
    "form": "mandatory"
  },
  "signUpForm": {
    "fullName": true,
    "firstName": true,
    "lastName": true,
    "email": true,
    "emailGateway": "none",
    "phone": true,
    "phoneGateway": "none",
    "extraFields": [],
    "showTermsAndConditions": true,
    "showPrivacyNotice": true
  },
  "basicInformation": {
    "age": true,
    "dateOfBirth": true,
    "gender": true,
    "address": true,
    "postalCode": true
  },
  "document": {
    "useGovernmentID": true,
    "usePassport": true,
    "useLicense": true,
    "verifyNames": true,
    "verifyCriminalHistory": true,
    "criminalEndpoints": [],
    "uploadDocumentAllowed": true,
    "scanDocumentAllowed": true,
    "validationMethod": "SCAN_PROMPT",
    "fallbackValidationMethod": "SCAN_PROMPT",
    "compareMinScore": 0.67,
    "maxAttempts": 3
  },
  "liveness": {
    "livenessMinScore": 0.9,
    "searchMode": "FAST",
    "searchMinScore": 0.95,
    "maxAttempts": 3
  },
}

---

Explanation of Key Concepts:

• Mandatory: The step or field is required, and the user cannot proceed without completing it.

• Optional: The step or field is not required, and the user can choose to skip it.

• Skip: The step or field is completely skipped in the flow.

---

Steps

steps: Defines the various steps in the onboarding process and whether they are mandatory, optional, or can be skipped.

options: ["mandatory", "optional", "skip"]

• signUpForm: Defines whether the sign-up form is mandatory, optional, or can be skipped.

• basicInformation: Defines whether gathering basic user information (e.g., name, email) is mandatory, optional, or can be skipped.

• document: Specifies the requirement to submit documents like IDs or licenses.

• liveness: Specifies the use of liveness detection (face recognition) during the onboarding process.

• form: Refers to the custom form that may be presented as part of the onboarding flow.

---

SignUp Form

signUpForm: This section defines the fields that will be part of the sign-up form.

• fullName: A Boolean that determines if the full name field is part of the sign-up form.

• firstName: A Boolean that determines if the first name field is required.

• lastName: A Boolean that determines if the last name field is required.

• email: A Boolean that determines if the email field is required for sign-up.

• emailGateway: Specifies the provider for email verification, such as "mailgun" or "none".

• phone: A Boolean that determines if a phone number field is required.

• phoneGateway: Specifies the provider for phone verification, such as "sms", "whatsapp", "both", or "none".

• extraFields: A list that can contain extra fields required during the sign-up process.

• showTermsAndConditions: A Boolean that specifies whether to display terms and conditions.

• showPrivacyNotice: A Boolean that specifies whether to display a privacy notice.

---

Basic Information

basicInformation: Defines the fields required to collect basic user information.

• age: A Boolean that determines if the age field is required.

• dateOfBirth: A Boolean that determines if the date of birth field is required.

• gender: A Boolean that determines if the gender field is required.

• address: A Boolean that determines if the address field is required.

• postalCode: A Boolean that determines if the postal code field is required.

---

Document

document: Defines the settings for the document validation process.

• useGovernmentID: A Boolean that determines if a government-issued ID is required.

• usePassport: A Boolean that determines if a passport can be used as identification.

• useLicense: A Boolean that determines if a driver’s license can be used as identification.

• verifyNames: A Boolean that determines if the user’s name will be verified against the document.

• verifyCriminalHistory: A Boolean that determines if the user’s criminal history will be checked.

• criminalEndpoints: A list of endpoints for checking criminal history.

• uploadDocumentAllowed: A Boolean that determines if document uploads are allowed.

• scanDocumentAllowed: A Boolean that determines if scanning documents is allowed.

• validationMethod: Specifies the method used for document validation. Options include "SCAN_ZERO", "SCAN_PROMPT", and "SCAN_STUDIO".

• fallbackValidationMethod: Specifies the fallback method for validation if the primary method fails.

• compareMinScore: A number between 0.5 and 1 that determines the minimum score required for a document validation to be successful.

• maxAttempts: Specifies the maximum number of validation attempts allowed.

---

Liveness

liveness: Defines the settings for liveness detection (to confirm that the user is physically present during the onboarding process).

• livenessMinScore: A number that specifies the minimum score required for liveness detection.

• searchMode: Defines the mode for facial recognition. Options are "FAST" or "ACCURATE".

• searchMinScore: Specifies the minimum score required to consider a match between the user's face and the stored face data.

• maxAttempts: Specifies the maximum number of liveness detection attempts allowed.