AdditionalCustomerLiveCheckData

public struct AdditionalCustomerLiveCheckData : Encodable

Child structure of CustomerLiveCheckRequest.

Enumerations

  • Whether or not to strip special characters. Default is yes.

    See more

    Declaration

    Swift

    public enum StripSpecialCharacters : String, Encodable

  • If set to Y, the selfie will be sent to the biometric engine to obtain an estimation of the subject’s age. Default is no.

    See more

    Declaration

    Swift

    public enum EstimateAge : String, Encodable

  • If set to Y, the selfie will be sent to the biometric engine to obtain an Predicted Gender. Default is no.

    See more

    Declaration

    Swift

    public enum PredictGender : String, Encodable
  • See more

    Declaration

    Swift

    public enum DetectLabel : String, Encodable
  • See more

    Declaration

    Swift

    public enum DetectClosedEyes : String, Encodable
  • See more

    Declaration

    Swift

    public enum SendDocumentIdInResponse : String, Encodable

Properties

  • idToken which has SHA256 data of request.

    Declaration

    Swift

    public var idToken: String?

  • Mandatory Unique Identifier generated by the client application that will be stored with the form and can be subsequently used to search form. This is required to be unique for each form and should have logic to ensure that. Recommendation is to include items such as the timestamp and Login ID. It can be as long as 256 characters. Default is a UUID.

    Declaration

    Swift

    public var uniqueRequestId: String

  • Client Request ID generated by client applicationIt can be as long as 256 characters.

    Declaration

    Swift

    public var clientRequestID: String?

  • Whether or not to strip special characters. Default is yes.

    Declaration

    Swift

    public var stripSpecialCharacters: StripSpecialCharacters?

  • If set to Y, the selfie will be sent to the biometric engine to obtain an estimation of the subject’s age. Default is no.

    Declaration

    Swift

    public var estimateAge: EstimateAge?

  • If set to Y, the selfie will be sent to the biometric engine to obtain an Predicted Gender. Default is no.

    Declaration

    Swift

    public var predictGender: PredictGender?

  • Get location details in GPS Co-ordinate Format (Latitude & Longitude).

    Declaration

    Swift

    public var gpsCoordinates: String?

  • Valid values are: Y or N

    Declaration

    Swift

    public var detectLabel: DetectLabel?

  • Eye close detection. Valid values are: Y or N

    Declaration

    Swift

    public var detectClosedEyes: DetectClosedEyes?

  • Returns urn for documents instead of Base64 data in response. Valid values are: Y or N

    Declaration

    Swift

    public var sendDocumentIdInResponse: SendDocumentIdInResponse?

  • Additional ID and/or Selfie Capture image metadata.

    Declaration

    Swift

    public var metadata: Metadata?

  • Additional decoded MRZ and/or Barcode metadata.

    Declaration

    Swift

    public var ocrMetadata: String?

Initialization

  • Designated initializer.

    Declaration

    Swift

    public init(idToken: String? = "",
            uniqueRequestId: String = IDentitySDK.requestID,
            clientRequestID: String? = nil,
            stripSpecialCharacters: StripSpecialCharacters? = .yes,
            estimateAge: EstimateAge? = .no,
            predictGender: PredictGender? = .no,
            gpsCoordinates: String? = nil,
            detectLabel: DetectLabel? = .no,
            detectClosedEyes: DetectClosedEyes? = .yes,
            sendDocumentIdInResponse: SendDocumentIdInResponse? = .yes)

    Parameters

    idToken

    idToken which has SHA256 data of request.
    uniqueRequestId

    Mandatory Unique Identifier generated by the client application that will be stored with the form and can be subsequently used to search form. This is required to be unique for each form and should have logic to ensure that. Recommendation is to include items such as the timestamp and Login ID. It can be as long as 256 characters. Default is a UUID.
    clientRequestID

    Client Request ID generated by client applicationIt can be as long as 256 characters.
    stripSpecialCharacters

    Valid values are: Y : N
    estimateAge

    If set to Y, the selfie will be sent to the biometric engine to obtain an estimation of the subject’s age.
    predictGender

    If set to Y, the selfie will be sent to the biometric engine to obtain an Predicted Gender.
    gpsCoordinates

    Get location details in GPS Co-ordinate Format (Latitude & Longitude).
    detectLabel

    Valid values are: Y or N
    detectClosedEyes

    Eye close detection. Valid values are: Y : N
    sendDocumentIdInResponse

    Returns urn for documents instead of Base64 data in response. Valid values are: Y : N.