Skip to main content

Communication

Upload a document and get instant results. Gain a deeper understanding of how Veryfi Lens interacts with your application.

Download on theApp StoreDownload on theGoogle Play

  1. Set your delegate:
VeryfiLens.shared().delegate = self
  1. Implement the delegate methods:
extension ViewController: VeryfiLensDelegate {

func veryfiLensClose(_ json: [String : Any]) {
    let jsonData = try? JSONSerialization.data(withJSONObject: json as Any, options: .prettyPrinted)
    let jsonString = String(data: jsonData!, encoding: .utf8)
    print(String("veryfiLensClose: " + jsonString!))   // do something with the JSON here
}

func veryfiLensUpdate(_ json: [String : Any]) {
    let jsonData = try? JSONSerialization.data(withJSONObject: json as Any, options: .prettyPrinted)
    let jsonString = String(data: jsonData!, encoding: .utf8)
    print(String("veryfiLensUpdate: " + jsonString!))   // do something with the JSON here
}

func veryfiLensSuccess(_ json: [String : Any]) {
    let jsonData = try? JSONSerialization.data(withJSONObject: json as Any, options: .prettyPrinted)
    let jsonString = String(data: jsonData!, encoding: .utf8)
    print(String("veryfiLensSuccess: " + jsonString!))   // do something with the JSON here
}

func veryfiLensError(_ json: [String : Any]) {
    let jsonData = try? JSONSerialization.data(withJSONObject: json as Any, options: .prettyPrinted)
    let jsonString = String(data: jsonData!, encoding: .utf8)
    print(String("veryfiLensError: " + jsonString!))   // do something with the error JSON here
}
}

Note: If your project is using Swift 6 add @preconcurrency keyword to your delegate implementation like this:​

extension ViewController: @preconcurrency VeryfiLensDelegate {
    //... Delegate methods implementation
}

Delegate Definitions​

  • veryfiLensClose - the Veryfi Lens camera has been closed, either as a result of submitting an image for processing, or the user closed the camera without submitting an image.
{
    "status": "close",
    "queue_count": 1,
    "framework-version": "1.4.0",
    "session_scan_count": 1,
    "framework-build": "1"
}

NOTE: In the object above, queue_count refers to the number of submitted documents that are currently in the processing queue. session_scan_count refers to the number of documents that were submitted in the most recent Lens camera session - if this is equal to 0 (zero) then the camera session was canceled without submitting anything.

  • veryfiLensUpdate - during the processing of a document, this delegate will be fired multiple times. One time it will contain the thumbnail path for the submitted document and one time it will contain a full-size image path. In addition, multiple instances of this delegate will be fired containing the current upload progress percentage.

Credit card information extracted, you will receive this JSON multiple times with new values if there is any

{
    "card_number": "",
    "card_name": "DIEGO ALONSO URIBE",
    "card_type": "",
    "card_dates": [
        "09/01",
        ""
    ],
    "card_cvc": "",
    "card_uuid": "2f629eda-9f21-430a-885e-b8d6368ae80c"
}
  • veryfiLensError - if an error occurs during uploading or processing a submitted or a general exception or crash is caught in Veryfi Lens, this notification contains the error details.

Sample error data:

{
    "status": "error",
    "package_id": "edc8653e4c2b4ef1",
    "error": "[Wombat].Reachability.noInternetConnection"
}
  • veryfiLensSuccess - this delegate fires once a document has finished processing, whether it was submitted via the camera, the gallery, or it was dictated or entered/typed manually. This delegate provides the response from the Veryfi API.

Sample data:

{
    "card_number": "6473 5375 9774 6799",
    "card_name": "DIEGO ALONSO URIBE",
    "card_type": "visa",
    "card_dates": [
        "09/01",
        ""
    ],
    "card_cvc": "",
    "card_uuid": "2f629eda-9f21-430a-885e-b8d6368ae80c"
}