This section covers how to integrate with the Incode Platform using the Omni API. It covers the full onboarding lifecycle: starting a session, generating a URL for that session, running onboarding through direct API calls, and fetching results once onboarding finishes.
Create an Onboarding Session: Start a new onboarding session with the
/omni/startendpoint. This page covers the required headers, request body values, and how to handle the response.Generate Onboarding URL: Generate a unique URL for an onboarding session using the
/omni/onboarding-urlendpoint. This page covers the required headers and includes sample code.API Batch Processing: Run a complete onboarding using only API calls, in sequential order, without an SDK. This page also covers the setup you need before you begin and links to each step in a basic onboarding flow.
How to Fetch Results and Data: Learn what data is available once onboarding finishes, including scores, OCR data, device and geolocation data, and uploaded images. This page also covers how to trigger result retrieval, either through a webhook notification or your own app logic.