This section will help you understand the definitions of various functions detailed within our IOS Native SDK.

Orbit4ScanID Framework

📘

Note:

4ScanID is the same as the ANZBinding.

Functions

Definitions

Example Usage

Example Result

+ (NSString *)sdkVersion;

This function returns the SDK version string.

let sdkVersion = Orbit4ScanIDViewController.sdkVersion()

“V.3.1.0"

+ (NSString *)sdkBuildDate;

This function returns the date when the SDK is built.

let sdkBuildDate = Orbit4ScanIDViewController.sdkBuildDate()

"Build 2022.03.15”

(id)initWithDelegate:(id<Orbit4ScanIDResultDelegate>)delegate;

Initializes the Orbit4ScanIDViewController with Orbit4ScanIDResultDelegate.

let scanidVC = Orbit4ScanIDViewController.init(delegate: self)

+ (NSarray *)getSupportedDocumentTypesWithCountry: (NSString *)country;

Gets the document types that this SDK supports from the country codes.

let supportedDocuments = Orbit4ScanIDViewController.getSupportedDocumentTypes(withCountry: "AUS")

DOC_ID_UNKNOWN,
AUS_ACT_DRIVERLICENCE,
AUS_ACT_PROOFOFAGE,
AUS_NSW_DRIVERLICENCE,
AUS_NSW_PHOTOCARD,
AUS_NSW_PROOFOFAGE,
AUS_NSW_FIREARMS,
AUS_NSW_BOATDRIVERLICENCE,
AUS_QLD_DRIVERLICENCE,
AUS_QLD_PROOFOFAGE,
AUS_QLD_ID,
AUS_QLD_INDUSTRY,
AUS_VIC_DRIVERLICENCE,
AUS_VIC_PROOFOFAGE,
AUS_TAS_DRIVERLICENCE,
AUS_TAS_PROOFOFAGE,
AUS_TAS_PERSON,
AUS_NT_DRIVERLICENCE,
AUS_NT_PROOFOFAGE,
AUS_NT_NEW_DRIVERLICENCE,
AUS_NT_NEW_EVIDENCEAGE,
AUS_SA_DRIVERLICENCE,
AUS_SA_PROOFOFAGE,
AUS_WA_DRIVERLICENCE,
AUS_WA_PHOTOCARD,
AUS_WA_PROOFOFAGE,
AUS_IMMICARD,
AUS_MEDICARE,
NZL_DRIVERLICENCE,
NZL_DRIVERLICENCE_BACK,
CAN_AB_DRIVERLICENCE,
CAN_BC_DRIVERLICENCE,
CAN_ON_DRIVERLICENCE,
CAN_XX_PDF417,
PASSPORT,
AUS_AUTO_DRIVERLICENCE,
AUS_AUTO_IDCARD,
EUR_UK_DRIVERLICENCE,
EUR_FR_DRIVERLICENCE,
EUR_GE_DRIVERLICENCE,
EUR_AUTO_DRIVERLICENCE

+ (NSarray *)getSupportedCountries;

Gets the available country codes.

let countryCodes = Orbit4ScanIDViewController.getSupportedCountries()

some : 7 elements

  • 0 : AUS
  • 1 : CAN
  • 2 : IND
  • 3 : IDN
  • 4 : MYS
  • 5 : NZL
  • 6 : USA

orbitIdVC.scanBackSide =

Enables the scanning of the back side of card. This function has 2 values, 'true' and 'false'. You can set the value to 'true' to enable the back side of the card scanning process or 'false' to disable it.

public boolean showCapturePreview = value

Show Capture Preview is a feature where you can preview the document prior to taking a picture of that document. To show capture preview put true value and false value not to show capture preview.

public boolean showCapturePreview = true

Orbit4ScanIDResultDelegate

📘

Note:

4ScanID is the same as the ANZBinding.

Functions

Definitions

func responseOrbit4ScanIDResult(_ sdkViewController: Orbit4ScanIDViewController!, result: ScanIDOCRResult!, imageDocFront imgDocF: UIImage!, imageDocBack imgDocB: UIImage!, imgDocFace: UIImage!, imageCameraFace imgCamFace: UIImage!)

Returns Orbit4ScanIDResult and detected images like front, back card and face.

Orbit4Medicare Framework

Functions

Definitions

Example Usage

Example Result

+ (NSString *)sdkVersion;

This function returns the SDK version string.

let sdkVersion = Orbit4MedicareViewController.sdkVersion()

“V.3.1.0"

+ (NSString *)sdkBuildDate;

This function returns the date when the SDK is built.

let sdkBuildDate = Orbit4MedicareViewController.sdkBuildDate()

"Build 2022.03.15”

(id)initWithDelegate:(id<Orbit4MedicareResultDelegate>)delegate;

Initializes Orbit4MedicareViewController with Orbit4MedicareResultDelegate.

let orbitMedicareVC = Orbit4MedicareViewController.init(delegate: self)

Orbit4MedicareResultDelegate

Functions

Definitions

func responseOrbit4MedicareResult(_ sdkViewController: Orbit4MedicareViewController!, result: MedicareOCRResult!, frontImage: UIImage!, back backImage: UIImage!, face faceImage: UIImage!)

Returns Orbit4MedicareResult and detected images.

OrbitMrz Framework

Functions

Definitions

Example Usage

Example Result

public static String sdkVersion()

This function returns Sdk version string.

let sdkVersion = OrbitMrzViewController.sdkVersion()

“V.3.1.0"

public static String sdkBuildDate()

This function returns the date Sdk built.

let sdkBuildDate = OrbitMrzViewController.sdkBuildDate()

"Build 2022.03.15”

(id)initWithDelegate:(id<OrbitMrzViewControllerDelegate>)delegate;

Initializes OrbitMrzViewController with OrbitMrzViewControllerDelegate

let mrzVC = OrbitMrzViewController.init(delegate: self)

OrbitMrzViewControllerDelegate

Functions

Definitions

func responsed(_ response: MRZOCRResult!, with image: UIImage!, face imgFace: UIImage!, in mrzViewController: OrbitMrzViewController!)

Returns OrbitMrzResult and detected images.

💬 We're here to help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.