Class FaceSDK

env

locale

tenant

customization

• get customization(): Customization

  Returns Customization

• set customization(val: Customization): void

  Parameters

  • val: Customization

  Returns void

localizationDictionary

• get localizationDictionary(): Record<string, string> | null

  A localization dictionary to override default localization logic. Allows to replace any string of FaceSDK with an arbitrary string.

  To see all the localization keys, look up the RegulaSDK.strings file at ios/Pods/FaceSDK/FaceSDK.xcframework/ios-arm64/FaceSDK.framework/FaceSDK.bundle/en.lproj/FaceSDK.strings.

  Immutable property. Use setter instead of editing.

  Returns Record<string, string> | null

• set localizationDictionary(val: Record<string, string> | null): void

  Parameters

  • val: Record<string, string> | null

  Returns void

personDatabase

• get personDatabase(): PersonDatabase

  Returns PersonDatabase

requestHeaders

• get requestHeaders(): Record<string, string> | null

  Immutable property. Use setter instead of editing.

  Returns Record<string, string> | null

• set requestHeaders(val: Record<string, string> | null): void

  Parameters

  • val: Record<string, string> | null

  Returns void

serviceUrl

• get serviceUrl(): string | null

  Returns string | null

• set serviceUrl(val: string | null): void

  Parameters

  • val: string | null

  Returns void

version

• get version(): FaceSDKVersion | null

  Information about the SDK.

  Returns FaceSDKVersion | null

videoEncoderCompletion

• set videoEncoderCompletion(completion: VideoEncoderCompletion): void

  Allows user to receive a video file of current session.

  Parameters

  • completion: VideoEncoderCompletion

  Returns void

Staticinstance

• get instance(): FaceSDK

  The only instance of singleton class FaceSDK.

  Returns FaceSDK

deinitialize

• deinitialize(): void

  Used to deinitialize FaceSDK and free up RAM as a consequence of this.

  Returns void

detectFaces

• detectFaces(request: DetectFacesRequest): Promise<DetectFacesResponse>

  Parameters

  • request: DetectFacesRequest

  Returns Promise<DetectFacesResponse>

enrollWithTrustedPhoto

• enrollWithTrustedPhoto(request: EnrollmentRequest): Promise<EnrollmentResponse>

  Parameters

  • request: EnrollmentRequest

  Returns Promise<EnrollmentResponse>

initialize

• initialize(
      options?: { config?: InitConfig },
  ): Promise<[boolean, InitException | null]>

  Allows you to initialize FaceSDK.

  Parameters

  • Optionaloptions: { config?: InitConfig }

  Returns Promise<[boolean, InitException | null]>

  Returns boolean indicating success of initialization and a nullable InitException.

isInitialized

• isInitialized(): Promise<boolean>

  Checks if FaceSDK is initialized.

  Returns Promise<boolean>

matchFaces

• matchFaces(
      request: MatchFacesRequest,
      options?: { config?: MatchFacesConfig },
  ): Promise<MatchFacesResponse>

  Parameters

  • request: MatchFacesRequest
  • Optionaloptions: { config?: MatchFacesConfig }

  Returns Promise<MatchFacesResponse>

splitComparedFaces

• splitComparedFaces(
      facesPairs: ComparedFacesPair[],
      similarityThreshold: number,
  ): Promise<ComparedFacesSplit>

  Parameters

  • facesPairs: ComparedFacesPair[]
  • similarityThreshold: number

  Returns Promise<ComparedFacesSplit>

startEnrollment

• startEnrollment(
      config: EnrollmentConfig,
      options?: {
          cameraSwitchCallback?: CameraSwitchCallback;
          notificationCompletion?: LivenessNotificationCompletion;
      },
  ): Promise<[LivenessResponse, EnrollmentResponse | null]>

  Parameters

  • config: EnrollmentConfig
  • Optionaloptions: {
        cameraSwitchCallback?: CameraSwitchCallback;
        notificationCompletion?: LivenessNotificationCompletion;
    }

  Returns Promise<[LivenessResponse, EnrollmentResponse | null]>

startFaceCapture

• startFaceCapture(
      options?: {
          cameraSwitchCallback?: CameraSwitchCallback;
          config?: FaceCaptureConfig;
      },
  ): Promise<FaceCaptureResponse>

  Parameters

  • Optionaloptions: { cameraSwitchCallback?: CameraSwitchCallback; config?: FaceCaptureConfig }

  Returns Promise<FaceCaptureResponse>

startLiveness

• startLiveness(
      options?: {
          cameraSwitchCallback?: CameraSwitchCallback;
          config?: LivenessConfig;
          notificationCompletion?: LivenessNotificationCompletion;
      },
  ): Promise<LivenessResponse>

  Parameters

  • Optionaloptions: {
        cameraSwitchCallback?: CameraSwitchCallback;
        config?: LivenessConfig;
        notificationCompletion?: LivenessNotificationCompletion;
    }

  Returns Promise<LivenessResponse>

startVerification

• startVerification(
      config: VerificationConfig,
      options?: {
          cameraSwitchCallback?: CameraSwitchCallback;
          notificationCompletion?: LivenessNotificationCompletion;
      },
  ): Promise<[LivenessResponse, VerificationResponse | null]>

  Parameters

  • config: VerificationConfig
  • Optionaloptions: {
        cameraSwitchCallback?: CameraSwitchCallback;
        notificationCompletion?: LivenessNotificationCompletion;
    }

  Returns Promise<[LivenessResponse, VerificationResponse | null]>

stopFaceCapture

• stopFaceCapture(): void

  Returns void

stopLiveness

• stopLiveness(): void

  Returns void