Run a workflow

DeepIDVWorkflowView runs a workflow you built in the Admin Console against one session, step by step, and reports one result when the user is done. Supported steps: ID verification (one, two or three documents) and face liveness. A workflow with any other step fails with .validation before the camera opens.

Three ways to start

Session from your backend (recommended)
Let the view create it
Resume a session

Your backend creates the session with Create workflow session and passes the app its ID.

DeepIDVWorkflowView(client: client, sessionID: sessionID) { result in
    // handle the result
}

The session must be new: one that has started or finished fails with .conflict. To continue a started session, resume it.

The view creates the session from the app. The user’s details are sent from the device.

DeepIDVWorkflowView(
    client: client,
    workflowID: "YOUR_WORKFLOW_ID",
    user: WorkflowUser(
        email: "jane.doe@example.com",
        firstName: "Jane",
        lastName: "Doe",
        phone: "+14155552671",    // optional, E.164
        externalID: "user_12345"  // optional, your own ID
    )
) { result in
    // handle the result
}

Continue a session that started but didn’t finish. See Resuming.

DeepIDVWorkflowView(client: client, resumingSessionID: sessionID) { result in
    // handle the result
}

Every initializer also takes documentCamera: to choose the camera for this view only. See Camera.

Sessions from your backend

Creating the session on your backend keeps the user’s details on your server, ties the session to a signed-in user, and lets your proxy refuse requests for anyone else’s session.

Present it full screen

The view fills the screen and runs the camera. Present it with fullScreenCover (SwiftUI) or a full-screen UIHostingController (UIKit), and close it from onResult.

.fullScreenCover(isPresented: $isVerifying) {
    DeepIDVWorkflowView(client: client, sessionID: sessionID) { result in
        isVerifying = false
        // handle the result
    }
}

UIKit

let controller = UIHostingController(
    rootView: DeepIDVWorkflowView(client: client, sessionID: sessionID) { [weak self] result in
        self?.dismiss(animated: true)
        // handle the result
    }
)
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)

What the user sees

iPhone screen: a lock badge with 'Preparing your verification, this only takes a moment'. — Around the steps: preparing, sending, a retry, and the closing screen.

iPhone screen: the captured sample ID and a selfie thumbnail with 'Verifying your identity, securely sending your photos' and a progress bar. — Around the steps: preparing, sending, a retry, and the closing screen.

Moment	Screen	Notes
Opening	Preparing your verification	Fetches the workflow and starts the session. A resumed session shows Picking up where you left off.
ID verification	Document picker, then the document camera, then the selfie	The picker lists only the document types the workflow accepts, and is skipped when it accepts just one. Cards are captured front and back unless the workflow marks the type front-only; passports are always front-only. A second or third document repeats the picker.
Sending	Verifying your identity	Shows the ID and selfie just taken while the photos upload.
A check fails	Retry screen with the attempts left	The SDK retakes only what failed: the selfie, or the document with the same type, or returns to the picker if the type isn’t accepted. See Failures.
Face liveness	The liveness check
Done	Thanks, you’re done	The same whatever the decision, so it never tells the user whether they passed. Closes after 3 seconds or with Done, then `onResult` fires.
Error	Error screen	Network and server errors offer Try again, which continues from the current step.

To skip the closing screen and return to your app straight away, set showsCompletionScreen to false in DeepIDVConfig.

Handle the result

onResult fires exactly once, with a Result<WorkflowRunResult, DeepIDVError>.

DeepIDVWorkflowView(client: client, sessionID: sessionID) { result in
    switch result {
    case .success(let run):
        if let failure = run.sessionFailure {
            // The run ended without being submitted, e.g. attempts ran out.
            showMessage(for: failure.code)
        } else {
            showSubmittedScreen()   // the decision arrives on your backend
        }
    case .failure(let error):
        switch error.kind {
        case .cancelled:
            break                    // the user closed it
        case .cameraPermissionDenied:
            showCameraHelp()
        default:
            showGenericError()
        }
    }
}

.success means the run ended normally: submitted, or out of attempts (sessionFailure is set).
.failure is for errors: network, permissions, cancellation, a session that can’t run.

Details: Results and the decision, Failures, Errors.

Headless session calls

To inspect or drive a session without UI:

Method	Does
`createWorkflowSession(workflowID:user:expiresInHours:)`	Creates a session (prefer your backend).
`startWorkflowSession(sessionID:)`	Starts it.
`resumeWorkflowSession(sessionID:)`	Returns where an unfinished session stands.
`fetchWorkflowState(sessionID:)`	Reads the state of any session, finished or not.

Each returns a WorkflowExecutionState (or WorkflowSession for create) with the steps, their status, attempts left and failures.

Guides

TypeScript

iOS

Three ways to start

Sessions from your backend

Present it full screen

What the user sees

Handle the result

Headless session calls

​Three ways to start

​Sessions from your backend

​Present it full screen

​What the user sees

​Handle the result

​Headless session calls

Three ways to start

Sessions from your backend

Present it full screen

What the user sees

Handle the result

Headless session calls