AdditionalCustomerCommonData

public struct AdditionalCustomerCommonData : Encodable

Child structure of CustomerIdentifyRequest and CustomerVerifyRequest.

Enumerations

  • Whether or not the POST_API call will get triggered. Default is no.

    See more

    Declaration

    Swift

    public enum PostDataAPIRequired : String, Encodable

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

    See more

    Declaration

    Swift

    public enum StripSpecialCharacters : String, Encodable

  • If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are: Y : N

    See more

    Declaration

    Swift

    public enum SendMetaDataInPost : 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

  • Verification Approval Code

    Declaration

    Swift

    public var verificationApprovalCode: 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?

  • The POST Data API is used to accept the results and extracted data from the service. This requires a URL to be specified for the POST to be sent to. Default is no.

    Declaration

    Swift

    public var postDataAPIRequired: PostDataAPIRequired?

  • If the postDataAPIRequired request parameter = Y, this field can be used to provide the URL that the postDataAPI webhook will be posted to. This will override any settings that are stored for the particular company the request is being submitted to.

    Declaration

    Swift

    public var postDataAPIURL: String?

  • If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Default is yes

    Declaration

    Swift

    public var sendMetaDataInPost: SendMetaDataInPost?

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

    Declaration

    Swift

    public var gpsCoordinates: String?

  • piiExclusion

    Declaration

    Swift

    public var piiExclusion: 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,
            verificationApprovalCode: String? = nil,
            clientRequestID: String? = nil,
            stripSpecialCharacters: StripSpecialCharacters? = .yes,
            postDataAPIRequired: PostDataAPIRequired? = .no,
            postDataAPIURL: String? = nil,
            sendMetaDataInPost: SendMetaDataInPost? = .yes,
            gpsCoordinates: String? = nil,
            piiExclusion: String? = nil,
            detectLabel: DetectLabel? = .no,
            detectClosedEyes: DetectClosedEyes? = .no,
            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
    verificationApprovalCode

    Verification Approval Code
    clientRequestID

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

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

    The POST Data API is used to accept the results and extracted data from the service. This requires a URL to be specified for the POST to be sent to. Default is no.
    postDataAPIURL

    If the postDataAPIRequired request parameter = Y, this field can be used to provide the URL that the postDataAPI webhook will be posted to. This will override any settings that are stored for the particular company the request is being submitted to.
    sendMetaDataInPost

    If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are: Y : N
    gpsCoordinates

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

    piiExclusion
    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.