SDK reference
Journey creation, UI launch and backend results for Workflows & UI.
Integration surfaces
The SDK integration connects a configured graphical journey to your application. It is not the same as calling each verification API yourself.
| Surface | Responsibility | Documentation |
|---|---|---|
| Backend journey creation | Authenticate and create the configured journey; keep credentials and sensitive identifiers server-side. | Your personalised handshake and integration instructions, supplied by IDCanopy. |
| UI launch | Open the returned uiHandle in an iframe or full-page navigation. | Hosted UI |
| Backend result delivery | Verify callbacks and correlate the outcome with your application. | Webhooks |
Launch handle
uiHandle is the runtime URL for the configured journey. Use the URL returned by journey creation, not a hardcoded host or a reconstructed token URL. It is a launch mechanism, not a completion result.
The browser completes the user-facing steps. The backend handles the trusted result; browser events are not a substitute for callback verification.
Your configured integration
Talk to IDCanopy about the journey you want to build. We will provide your configured workflow, personalised handshake request and integration instructions, including the enabled steps, authentication and result delivery. Contact office@idcanopy.com to get started.
Your agreed integration instructions define the handshake fields, step configuration and SDK details for your workflow. This page explains the common integration model; it is not a replacement for that tailored contract.
Pending verification: hosted UI and webhook details still need a live-service re-check. The linked guides retain their verification notices.
QES within workflows
QES is an upcoming workflow capability. The QES identify-and-sign reference currently describes a separate test-environment service, not the SDK journey contract. Its identification, document-upload and signing steps can inform future workflow integration, but must not be assumed available in the current SDK.
Start with the workflow quickstart for the end-to-end application pattern.