{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"redocly_category":"Guides","product":"Identity Verification","type":"markdown"},"seo":{"title":"Identity Verification with journeys","description":"Everything about Mosaic Journeys, SDKs, and APIs","siteUrl":"https://developer.transmitsecurity.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"identity-verification-with-journeys","__idx":0},"children":["Identity Verification with journeys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identity Verification allows you to securely verify the identity of your users by collecting a government-issued document (such as a driver's license, passport, or national ID card) and a live selfie, and then matching them against each other. This is useful for scenarios like onboarding new customers, account recovery, or verifying identity before granting access to sensitive operations."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide explains how to implement Identity Verification using ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/journeys_intro"},"children":["Journeys"]}," and SDKs."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":1},"children":["How it works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a user needs to verify their identity, the client starts the verification journey and Mosaic creates an Identity Verification session."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On mobile, the Orchestration SDK intercepts Document Acquisition and Selfie Acquisition, runs capture, and submits the result. On web, your client receives the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start_token"]}," from the Orchestration SDK and starts the Identity Verification session, captures the document and selfie, and submits an empty client response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After both images are collected, the Platform IDV Recommendation step evaluates the verification data. This step is client-facing: keep calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submitClientResponse()"]}," until the journey proceeds to the next step or returns an error. Based on the recommendation, the journey branches and either completes successfully or rejects access."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant User\n participant App as Client\n participant IDO as Orchestration SDK\n participant IDV as IDV SDK\n participant M as Mosaic\n\n User-->>App: Verify my identity\n App->>IDO: Init SDK\n App->>IDO: Start journey\n note over App, M: Journey runs...\n IDO-->>App: Document Acquisition\n App->>IDV: Capture document\n IDV-->>User: Mosaic UI\n User-->>IDV: Document image\n IDV-->>App: Complete\n App->>IDO: Complete\n IDO-->>App: Selfie Acquisition\n App->>IDV: Capture selfie\n IDV-->>User: Mosaic UI\n User-->>IDV: Selfie\n IDV-->>App: Complete\n App->>IDO: Complete\n IDO-->>App: IDV Recommendation\n App->>IDO: submitClientResponse()\n IDO-->>M: Get IDV recommendation\n M-->>M: Check recommendation\n M-->>IDO: Check result (yes/no)\n IDO-->>App: Journey complete\n App-->>User: Result\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant User\n participant App as Client\n participant IDO as Orchestration SDK\n participant IDV as IDV SDK\n participant M as Mosaic\n\n User-->>App: Verify my identity\n App->>IDO: Init SDK\n App->>IDO: Start journey\n note over App, M: Journey runs...\n IDO-->>App: Document Acquisition\n App->>IDV: Capture document\n IDV-->>User: Mosaic UI\n User-->>IDV: Document image\n IDV-->>App: Complete\n App->>IDO: Complete\n IDO-->>App: Selfie Acquisition\n App->>IDV: Capture selfie\n IDV-->>User: Mosaic UI\n User-->>IDV: Selfie\n IDV-->>App: Complete\n App->>IDO: Complete\n IDO-->>App: IDV Recommendation\n App->>IDO: submitClientResponse()\n IDO-->>M: Get IDV recommendation\n M-->>M: Check recommendation\n M-->>IDO: Check result (yes/no)\n IDO-->>App: Journey complete\n App-->>User: Result\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":2},"children":["Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["iOS:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["iOS 13+"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Xcode 11+"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Orchestration SDK 1.2.3 or later"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identity Verification SDK 1.3.5 or later"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Android:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Android 5+ (API level 21+)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Orchestration SDK 1.0.34 or later"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identity Verification SDK 1.3.5 or later"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SDK 2.4.0 or later"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":3},"children":["Before you start"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge-wrapper"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge"},"children":["Admin Portal"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If this is your first time integrating with Mosaic, create an application in the Admin Portal as described ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/user/create_new_application"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-build-journeys","__idx":4},"children":["Step 1: Build journeys"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge-wrapper"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge"},"children":["Admin Portal"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Admin Portal, go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["B2C Identity"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["B2B Identity"]}," based on your setup, and open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Journeys"]}," section. Create a journey that collects the user's document and selfie and obtains a verification recommendation, and branches based on the result. It can include the following actions:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/document_acquisition"},"children":["Document Acquisition"]}," step: captures a document image from the user."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/selfie_acquisition"},"children":["Selfie Acquisition"]}," step: captures a selfie image from the user."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/idv_recommendation"},"children":["Platform IDV Recommendation"]}," step: obtains an identity verification recommendation based on the collected document and selfie."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/condition"},"children":["Condition"]}," step: checks the recommendation using a condition expression, for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idv_recommendation.recommendation == 'ALLOW'"]},". If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the journey completes successfully (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/complete_journey"},"children":["Complete journey"]}," step). If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", the journey rejects access (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/reject_access"},"children":["Reject access"]}," step)."]}]},{"$$mdtype":"Tag","name":"figure","attributes":{"style":{"margin":"0"}},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/assets/idv_journey.6cb6050025253c748c11919b4f61b01b0a5ca0a0f67bfd4825857c6f48f49dac.6ece8e6a.png","target":"_blank"},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/idv_journey.6cb6050025253c748c11919b4f61b01b0a5ca0a0f67bfd4825857c6f48f49dac.6ece8e6a.png","alt":"Identity Verification journey","style":{"maxWidth":"100%"}},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{"style":{"color":"grey","fontStyle":"italic","fontSize":"14px"}},"children":["\n Click to open the image in a dedicated tab.\n "]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Alternative flow"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As an alternative to running capture on desktop, you can start the journey there and use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/create_cross-session_message"},"children":["cross-session messages"]}," to hand off the verification process from a desktop session to a mobile device."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-add-sdks","__idx":5},"children":["Step 2: Add SDKs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge-wrapper"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge"},"children":["client"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run this flow, your integration needs both the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Orchestration SDK"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Verification SDK"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make sure to initialize all SDKs within the context of the same client ID and the same region."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["For Web, see instructions here:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding to project/loading: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/idosdk/overview#installation"},"children":["Orchestration"]}," module, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/idvsdk/overview#installation"},"children":["Identity Verification"]}," module"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initializing: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/idosdk/overview#initialization"},"children":["Orchestration"]}," module, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/idvsdk/overview#initialization"},"children":["Identity Verification"]}," module"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["For Android, see instructions here:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding to project/loading: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/android/orchestration_overview#installation"},"children":["Orchestration SDK"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/android/identity_verification_overview#installation"},"children":["Identity Verification SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initializing: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/android/orchestration_overview#initialization"},"children":["Orchestration SDK"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/android/identity_verification_overview#initialization"},"children":["Identity Verification SDK"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["For iOS, see instructions here:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding to project/loading: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/ios/orchestration_overview#installation"},"children":["Orchestration SDK"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/ios/identity_verification_overview#installation"},"children":["Identity Verification SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initializing: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/ios/orchestration_overview#initialization"},"children":["Orchestration SDK"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/mobile/ios/identity_verification_overview#initialization"},"children":["Identity Verification SDK"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-implement-journey-logic","__idx":6},"children":["Step 3: Implement journey logic"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge-wrapper"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"badge"},"children":["client"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Implement the client-side code needed to execute the journey on the user's device."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In a nutshell, you have to implement:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Starting the journey"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handling document and selfie acquisition"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Polling for the IDV recommendation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/condition"},"children":["Condition"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/complete_journey"},"children":["Complete journey"]},", and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/reject_access"},"children":["Reject access"]}," are executed by Mosaic and don't require any client-side code."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Implementation tips"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On mobile, register an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ITSUIHandler"]}," after you initialize the Orchestration SDK and before you start the journey. The SDK intercepts Document Acquisition and Selfie Acquisition, so you don't handle those ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journeyStepId"]}," values in your journey switch. You still handle Platform IDV Recommendation in the switch: keep calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submitClientResponse()"]}," until the next step arrives."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On web, implement a switch (or other routing mechanism) that invokes a handler for each journey step (returned in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idoServiceResponse.journeyStepId"]},"). Each handler processes data, displays whatever UI is needed, and calls ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submitClientResponse()"]}," when the interaction is concluded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The journey loops back to the switch unless Mosaic signals journey completion by setting the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["journeyStepId"]}," property to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Rejection.type"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Success.type"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idoServiceResponse.token"]}," property contains a JWT token as a proof of journey completion."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more guidance, see the Orchestration SDK quickstarts for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/quick_start_web"},"children":["Web"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/quick_start_android"},"children":["Android"]},", or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/quick_start_ios"},"children":["iOS"]},", as well as the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/document_acquisition"},"children":["Document Acquisition"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/selfie_acquisition"},"children":["Selfie Acquisition"]}," step guides."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-starting-the-journey","__idx":7},"children":["1. Starting the journey"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Implement a handler that starts the journey by replacing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR_JOURNEY_ID"]}," with the journey ID you created in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#step-1-build-journeys"},"children":["Step 1"]},". On mobile, register the UI handler before you call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startJourney()"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"const idoResponse = await ido.startJourney('YOUR_JOURNEY_ID');\n","lang":"js"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Kotlin","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"kotlin","header":{"controls":{"copy":{}}},"source":"TSIdo.startJourney(\"YOUR_JOURNEY_ID\", startJourneyOptions, callback)\n","lang":"kotlin"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Swift","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n try TSIdo.startJourney(journeyId: \"YOUR_JOURNEY_ID\")\n} catch {\n debugPrint(\"[DEBUG] Failed to start journey: \\(error)\")\n}\n","lang":"swift"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-handle-document-and-selfie-acquisition","__idx":8},"children":["2. Handle document and selfie acquisition"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Implement image collection and submission for verification:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#mobile-apps"},"children":["Mobile apps"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#web-apps"},"children":["Web apps"]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Mosaic checks camera permissions on the client but doesn't grant them. Make sure camera access is already in place before capture starts."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"mobile-apps","__idx":9},"children":["Mobile apps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ITSUIHandler"]}," after you initialize the Orchestration SDK and before you start the journey. The SDK intercepts Document Acquisition and Selfie Acquisition, runs capture, and submits the result. You don't start the Identity Verification SDK yourself."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Implement ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onBefore"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onAfter"]}," to present your own UI around the SDK capture screens (e.g., introduction screen, consent screen), then call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proceed()"]}," to continue."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Kotlin","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"kotlin","header":{"controls":{"copy":{}}},"source":"// Hook into document and selfie acquisition steps.\nclass MyUIHandler(private val activity: FragmentActivity) : ITSUIHandler {\n\n override fun provideDocumentAcquisitionHandler(): TSIDVStepHandler = TSIDVStepHandler().apply {\n onBefore = { context ->\n // Show your own UI before the SDK document capture starts, then continue.\n context.proceed()\n }\n onAfter = { context ->\n // Show your own UI after document acquisition completes, then continue.\n context.proceed()\n }\n }\n\n override fun provideSelfieAcquisitionHandler(): TSIDVStepHandler = TSIDVStepHandler().apply {\n onBefore = { context ->\n // Show your own UI before the SDK selfie capture starts, then continue.\n context.proceed()\n }\n onAfter = { context ->\n // Show your own UI after selfie acquisition completes, then continue.\n context.proceed()\n }\n }\n}\n\n// Register after TSIdo.initializeSDK(...) and before TSIdo.startJourney(...).\nTSIdo.setUIHandler(MyUIHandler(activity))\n\nTSIdo.startJourney(\"YOUR_JOURNEY_ID\", startJourneyOptions, callback)\n","lang":"kotlin"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Swift","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"// Hook into document and selfie acquisition steps.\nstruct MyUIHandler: ITSUIHandler {\n\n func provideDocumentAcquisitionHandler() -> TSIDVStepHandler {\n let handler = TSIDVStepHandler()\n handler.onBefore = { context in\n // Show your own UI before the SDK document capture starts, then continue.\n try? context.proceed()\n }\n handler.onAfter = { context in\n // Show your own UI after document acquisition completes, then continue.\n try? context.proceed()\n }\n return handler\n }\n\n func provideSelfieAcquisitionHandler() -> TSIDVStepHandler {\n let handler = TSIDVStepHandler()\n handler.onBefore = { context in\n // Show your own UI before the SDK selfie capture starts, then continue.\n try? context.proceed()\n }\n handler.onAfter = { context in\n // Show your own UI after selfie acquisition completes, then continue.\n try? context.proceed()\n }\n return handler\n }\n}\n\n// Register after TSIdo.initialize(...) and before TSIdo.startJourney(...).\ntry TSIdo.setUIHandler(MyUIHandler())\n\ntry TSIdo.startJourney(journeyId: \"YOUR_JOURNEY_ID\")\n","lang":"swift"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"web-apps","__idx":10},"children":["Web apps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the journey reaches Document Acquisition (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transmit_platform_document_acquisition"]},") or Selfie Acquisition (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transmit_platform_selfie_acquisition"]},"), the response data includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["acquisition_id"]}," (required): ID used to start capture"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start_token"]}," (optional): used to start an Identity Verification session if one isn't already active"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start_token"]}," is present, start the Identity Verification session, then call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["captureDocument()"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["captureSelfie()"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["acquisition_id"]},". After capture completes, submit an empty client response. Handle capture errors in the app (for example, inform the user or retry)."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"async function handleDocumentAcquisition(idoResponse) {\n const startToken = idoResponse.data?.start_token;\n const acquisitionId = idoResponse.data?.acquisition_id;\n\n // Start an Identity Verification session when the journey provides a start token\n if (startToken !== undefined) {\n await idv.start(startToken);\n }\n\n await idv.captureDocument({ acquisitionId });\n\n // After acquiring the document, the client response does not need to include any data\n // If SDK was loaded via script tag, invoke functions inside 'window.tsPlatform'\n return ido.submitClientResponse(ClientResponseOptionType.ClientInput);\n}\n\nasync function handleSelfieAcquisition(idoResponse) {\n const startToken = idoResponse.data?.start_token;\n const acquisitionId = idoResponse.data?.acquisition_id;\n\n if (startToken !== undefined) {\n await idv.start(startToken);\n }\n\n await idv.captureSelfie({ acquisitionId });\n\n return ido.submitClientResponse(ClientResponseOptionType.ClientInput);\n}\n","lang":"js"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-handle-idv-recommendation","__idx":11},"children":["3. Handle IDV recommendation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/idv_recommendation"},"children":["Platform IDV Recommendation"]}," is client-facing (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transmit_platform_idv_recommendation"]},") on web and mobile. Processing runs asynchronously on the backend. Keep calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submitClientResponse()"]}," with an empty client response until the journey proceeds to the next step or returns an error. Show a loader while processing runs. Mosaic recommends polling about once per second."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"async function handleIdvRecommendation() {\n let idoResponse;\n\n do {\n await new Promise((resolve) => setTimeout(resolve, 1000));\n // If SDK was loaded via script tag, invoke functions inside 'window.tsPlatform'\n idoResponse = await ido.submitClientResponse(ClientResponseOptionType.ClientInput);\n } while (idoResponse.journeyStepId === IdoJourneyActionType.WaitForIdvRecommendations);\n\n return handleJourneyResponse(idoResponse);\n}\n","lang":"js"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Kotlin","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"kotlin","header":{"controls":{"copy":{}}},"source":"private fun processServiceResponse(idoResponse: TSIdoServiceResponse) {\n when (idoResponse.journeyStepId) {\n TSIdoJourneyActionType.IdvRecommendation.type -> handleIdvRecommendation()\n }\n}\n\nprivate fun handleIdvRecommendation() {\n // Submit an empty response. If Mosaic is still processing, the callback\n // returns this step again—keep calling until the next step arrives.\n TSIdo.submitClientResponse(TSIdoClientResponseOptionType.ClientInput.type, null, callback)\n}\n","lang":"kotlin"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Swift","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func handleJourneyResponse(_ response: TSIdoServiceResponse) {\n switch response.journeyStepId {\n case .waitForIdvRecommendations:\n handleIdvRecommendation()\n default:\n break\n }\n}\n\nfunc handleIdvRecommendation() {\n do {\n // Submit an empty response. If Mosaic is still processing, the delegate\n // receives this step again—keep calling until the next step arrives.\n try TSIdo.submitClientResponse(clientResponseOptionId: .clientInput)\n } catch {\n debugPrint(\"[DEBUG] Failed to submit IDV recommendation poll: \\(error)\")\n }\n}\n","lang":"swift"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":12},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implement fallback logic for cases where document capture fails."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the verification result data (stored in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idv_recommendation"]}," output variable) to enrich user profiles with verified personal information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Instead of running capture on desktop, start the journey there and use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/journeys/create_cross-session_message"},"children":["cross-session messages"]}," to hand off verification to a mobile device."]}]}]},"headings":[{"value":"Identity Verification with journeys","id":"identity-verification-with-journeys","depth":1},{"value":"How it works","id":"how-it-works","depth":2},{"value":"Requirements","id":"requirements","depth":2},{"value":"Before you start","id":"before-you-start","depth":2},{"value":"Step 1: Build journeys","id":"step-1-build-journeys","depth":2},{"value":"Step 2: Add SDKs","id":"step-2-add-sdks","depth":2},{"value":"Step 3: Implement journey logic","id":"step-3-implement-journey-logic","depth":2},{"value":"1. Starting the journey","id":"1-starting-the-journey","depth":3},{"value":"2. Handle document and selfie acquisition","id":"2-handle-document-and-selfie-acquisition","depth":3},{"value":"Mobile apps","id":"mobile-apps","depth":4},{"value":"Web apps","id":"web-apps","depth":4},{"value":"3. Handle IDV recommendation","id":"3-handle-idv-recommendation","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"markdown":{"toc":{"depth":3}},"seo":{"title":"Identity Verification with journeys"}},"lastModified":"2026-10-04T13:21:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/verify/quick_start_journeys","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}