Incode SDKs use our API to capture and read session data. Therefore, anything added to a session via SDK can also be added via API calls. Batch processing enables you to run a complete onboarding using only API calls in sequential order, without using any of the available SDKs.
This section explains how to set up batch processing for a basic onboarding flow. If your flow includes additional modules, you will need to adjust for them.
Warning
While batch processing may seem more convenient, Incode cannot guarantee the quality of captured images since you're not using our SDKs. You must already have the user's images before you can run a batch process. Depending on your source for these images, the results of API-based onboardings may be as good as the ones done using the standard, SDK-based onboardings.
Before You Begin
To follow all the steps for setting up batch processing, make sure you have:
- An API key (provided by Incode)
- A Configuration ID for the flow you want to use. To copy it, go to Dashboard > Flow Builder > Flows or Workflows. For Flows, locate the flow you want to use, and click Copy in the Actions column. For Workflows, click the three dots in the Actions column and select Copy ID.
- Postman. Sample code and
cURLrequests are shared in the following pages. You can use thecURLsamples to import them into Postman and try them.
Basic Onboarding Flow
The following pages explain each of these steps in a basic onboarding flow from a batch processing perspective. We always recommend using our SDKs instead for the best quality results.
- Start onboarding session
- ID Validation
- Face Validation, including liveness and face match
- Complete the session