Integration Options
Overview
The ID Dataweb Platform offers three integration patterns. Each represents a different balance of implementation effort, UI control, and time to live. Choosing the right pattern depends on your technical resources, UX requirements, and how quickly you need to deploy.
| Gateway (OIDC) | ID Dataweb API | Hybrid | |
|---|---|---|---|
| Best for | Fastest integration, SSO systems | Full UI control, headless flows | Gradual migration from Gateway to API |
| UI | Hosted by ID Dataweb | Built by you | Mixed |
| Implementation effort | Low | High | Medium |
| Flexibility | Standard | Full | Flexible |
| User experience | Redirect-based | Embedded | Mixed |
Crawl, Walk, Run
Think of the three patterns as a maturity framework:
Crawl — Gateway (OIDC) The fastest path to a live verification flow. ID Dataweb hosts the UI. You redirect users to the Gateway, they complete verification, and you receive a signed ID Token with the result. Minimal engineering required.
Walk — Hybrid Start with Gateway for the initial verification steps, then continue the session via the ID Dataweb API. Useful when you want Gateway's speed for early steps but need API-level control for later steps or need to perform additional checks not supported in the Gateway flow.
Run — ID Dataweb API Maximum flexibility. You collect all user attributes and submit them to the API. You own the UI entirely. Requires more engineering but gives you full control over the experience, workflow logic, and real-time step orchestration.
When to Use Each
Gateway (OIDC)
Use Gateway when:
- You want to go live quickly with minimal engineering effort
- Your application already uses OIDC or single sign-on (SSO)
- You are comfortable with a redirect-based, hosted UI
- You want ID Dataweb to manage the verification user experience
See Gateway (OIDC) Integration for full implementation details.
ID Dataweb API
Use the API when:
- You need a fully embedded, branded verification experience
- You are building a headless or mobile-native flow
- You want fine-grained control over each verification step and the data submitted
- Your use case requires real-time, step-by-step orchestration of multiple checks
See ID Dataweb API for full implementation details.
Hybrid
Use Hybrid when:
- You are migrating from Gateway to API incrementally
- You want Gateway to handle initial verification steps, then branch into API-driven logic based on the outcome
- You want to serve both Gateway and API users from the same workflow without maintaining separate configurations
See Hybrid Integration for full implementation details.
Distribution Methods
Distribution methods define how the verification workflow reaches your end user. The right choice depends on your integration type, whether users are on desktop or mobile, and whether delivery is real-time or asynchronous. See Distribution Methods for information on each method.
Updated 11 days ago
