System preferences
To create your session please start by creating your system preferences. Each of the requested checks are explained in detail over the next few sections.
const sessionSpec = new SessionSpecificationBuilder() .withClientSessionTokenTtl(900) .withResourcesTtl(90000) .withUserTrackingId('some-user-tracking-id') .withRequestedCheck(documentAuthenticityCheck) .withRequestedCheck(livenessCheck) .withRequestedCheck(faceMatchCheck) .withRequestedTask(textExtractionTask) .withSdkConfig(sdkConfig) .withNotifications(notificationConfig) .build();The table below explains the optional parameters for the session and data retention configuration.
| Parameters | Description | Optional |
|---|---|---|
| withClientSessionTokenTtl | This is how long the full Identity verification session is open for in seconds. This must be longer than 300s (5 minutes). If a session has less than 10 minutes remaining a prompt will be shown to the user instructing that the session is near expiry. | ✅ |
| withResourcesTtl | Retention period ("time to live") for uploaded documents/images in number of seconds. Default is one week ( Note: This config may result in additional charges. Please get in touch with support if considering a TTL longer than three months. | ✅ |
| withUserTrackingId | Allows the relying business backend to track the same user across multiple sessions. Note: This should not contain any personal identifiable information. | ✅ |
| WithBlockBiometricConsent | For several American states (currently Texas, Illinois and Washington US states*), the law mandates that you must collect the user’s specific consent to collect their biometric details for our liveness or face matching feature to be compliant with the US legislation. *and any other countries or states within countries If you choose to only request specific consent in the above "territories" you must provide details of the effective geo location software you use to prevent any individuals located in one of these territories accessing the Yoti service without prior giving specific consent. Setting to true bypasses this screen. We recommend keeping this value to default (false) to enable consent for all users. | ✅ |