VerIDSessionResult

@objc(VerIDSessionResult)
public class VerIDSessionResult : NSObject, Codable

Represents a result of face detection and authentication

  • Error produced by the session or nil if the session is successful

    Declaration

    Swift

    @objc
internal(set) public var error: Error?

  • Faces and URLs of images collected in the session

    Declaration

    Swift

    @objc
internal(set) public var attachments: [DetectedFace]

  • URL of a video of the session. Only collected if the corresponding session settings had videoURL set.

    Declaration

    Swift

    @objc
public var videoURL: URL?

  • Constructs a result with error

    Declaration

    Swift

    @objc
public init(error: Error)

    Parameters

    error

    Error

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Detected faces

    Declaration

    Swift

    @objc
public var faces: [Face] { get }

  • Detected faces that are suitable for face recognition

    Declaration

    Swift

    @objc
public var facesSuitableForRecognition: [RecognizableFace] { get }

  • URLs of images collected in the session

    Declaration

    Swift

    @objc
public var imageURLs: [URL] { get }

  • Set of face bearings collected in the session

    Declaration

    Swift

    public var detectedBearings: Set<Bearing> { get }

  • Faces with given bearing

    Declaration

    Swift

    @objc
public func faces(withBearing bearing: Bearing) -> [Face]

    Parameters

    bearing

    Requested face bearing

    Return Value

    Array of faces

  • Faces with given bearing that are suitable for face recognition

    Declaration

    Swift

    @objc
public func facesSuitableForRecognition(withBearing bearing: Bearing) -> [RecognizableFace]

    Parameters

    bearing

    Requested face bearings

    Return Value

    Array of faces suitable for face recognition

  • URLs of images with the given face bearing

    Declaration

    Swift

    @objc
public func imageURLs(withBearing bearing: Bearing) -> [URL]

    Parameters

    bearing

    Requested face bearing

    Return Value

    Array of image URLs