Types for Face Liveness

Liveness Check Requests

type LivenessCheckRequest = {
  securityData: {
    userName: string
    password: string
    merchantId: number
  }
  customerData: {
    additionalData: {
      uniqueRequestId: string
    }
    biometricData: {
      selfie: string
    }
    idData: {
      idImageFront: string
    }
  }
  additionalData: {
    uniqueRequestId: string
    clientRequestID: string
    jobID: string
    sendDecisionDetailsInPost: "Y" | "N"
    stripSpecialCharacters: "Y" | "N"
    estimateAge: "Y" | "N"
    predictGender: "Y" | "N"
    metadata: string
  }
}

Liveness Check Responses

type LivenessCheckResponse = {
  status: {
    statusCode: string
    statusMessage: string
    errorData: string
  }
  resultData: {
    uniqueRequestId: string
    verificationResult: string
    verificationResultId: number
    verificationResultCode: string
    verificationResultDetails: {
      Decision_LiveCheck: {
        DecisionResult: string
        DecisionStateCode: string
      }
    }
    realScore: number
    eyeCovering: "true" | "false"
    eyeCoveringScore: number
    faceMask: "true" | "false"
    faceMaskScore: number
    headCovering: "true" | "false"
    headCoveringScore: number
    cellPhone: "true" | "false"
    cellPhoneScore: number
    estimatedAge: number
    livenessToken: string
  }
  additionalData: {
    liveFaceDetectionFlag: "true" | "false"
  }
}