API Batch Processing

About batch processing

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; that is, without using any of the available SDKs.

In this section, we'll look at how to set up batch processing for a basic onboarding flow. If your flow includes additional modules, you will need to adjust for this.

🚧

Keep in mind

While batch processing may seem more convenient, Incode cannot guarantee the quality of captured images since you're not using our SDKs. That means you must already have the user's images before you can run a batch process. Depending on your source for these images, you may find the results of API-based onboardings as good as the ones done using the standard, SDK-based onboardings.

Before you begin

Review the basics of the onboarding process and have a clear understanding of Incode concepts. The API depends heavily on access tokens, so make sure you also review and understand how to get an access token and the api reference intro.

To follow all the steps for setting up batch processing, make sure you have:

• Api Key (provided by Incode)

• Configuration Id for the flow you want to use. To copy it, go to Dashboard > Flows. Locate the flow you want to use, and click Copy in the Actions column.

• Postman. Sample code and cURL requests are shared in the following pages. You can use the cURL samples to import them into Postman and try them.

Basic onboarding flow

On the following pages, we'll discuss each of these steps in a basic onboarding flow. Remember, this discussion is 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

Updated about 2 months ago