Deprecated API
Deprecated
All methods on this page are deprecated and will be removed in a future release. Use the modern API instead.
start(token:isRoutedSession:preferredLanguage:bindingKey:fromViewController:listener:)
Starts an identity verification session.
public func start(
token: String,
isRoutedSession: Bool = false,
preferredLanguage: String = "",
bindingKey: String? = nil,
fromViewController: UIViewController,
listener: @escaping IDnowDocIDVResultListener
)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| token | String | ✅ | — | The session token, format XYZ-ABCDE |
| isRoutedSession | Bool | ➖ | false | Whether the session is routed |
| preferredLanguage | String | ➖ | "" | ISO 639-1 language code (e.g. "fr", "de") |
| bindingKey | String? | ➖ | nil | Optional key for device binding use cases |
| fromViewController | UIViewController | ✅ | — | The presenting view controller |
| listener | IDnowDocIDVResultListener | ✅ | — | Callback returning a result type and result code |
Example
IDnowDocIDV.shared.start(
token: "XYZ-ABCDE",
fromViewController: self
) { type, statusCode, message in
switch type {
case .FINISHED:
print("Success")
case .CANCELLED:
print("Cancelled: \(statusCode.description) - \(message)")
case .ERROR:
print("Error: \(statusCode.description) - \(message)")
}
}
IDnowDocIDVResultListener
Callback used by the deprecated start method.
public typealias IDnowDocIDVResultListener = (
IDnowDocIDV.IdentResult.type,
IDnowDocIDV.IdentResult.statusCode,
String
) -> Void
| Parameter | Type | Description |
|---|---|---|
| 1st | IdentResult.type | The result type of the session |
| 2nd | IdentResult.statusCode | The status code of the session |
| 3rd | String | A human-readable message |
IdentResult
Holds the result of an identification session. Nested class of IDnowDocIDV.
public class IdentResult
type
public enum type: Int {
case FINISHED
case CANCELLED
case ERROR
}
| Case | Raw Value | Description |
|---|---|---|
| FINISHED | — | The session completed successfully |
| CANCELLED | — | The session was cancelled by the user |
| ERROR | — | The session ended with an error |
statusCode
public enum statusCode: Int
| Case | Code | Description |
|---|---|---|
| E10 | 10 | Default error |
| E100 | 100 | Token format incorrect |
| E101 | 101 | Token not found |
| E102 | 102 | Token expired or deleted |
| E103 | 103 | Token already completed |
| E110 | 110 | Ident info response not parsable or empty |
| E111 | 111 | Ident info server error |
| E120 | 120 | Messages response not parsable or empty |
| E121 | 121 | Messages server error |
| E130 | 130 | Resources response not parsable or empty |
| E131 | 131 | Resources server error |
| E140 | 140 | QES name response not parsable or empty |
| E141 | 141 | QES name server error |
| E142 | 142 | QES name missing fullname |
| E150 | 150 | Start ident response not parsable or empty |
| E151 | 151 | Start ident server error |
| E152 | 152 | Start ident missing session key |
| E153 | 153 | VideoIdent token used in DocIDV SDK |
| E160 | 160 | Start ident via web failed |
| E170 | 170 | Backend forced websocket close |
| E171 | 171 | Backend command PROCESS_FAILED via websocket |
| EUnreachable | 1000 | Server unreachable |