Sign in

v1

latestOpenAPI 3.1.02026-07-263847150.4 KB

Initiate Flow

Generates a required token (for SDK) or a launch URL (for Web SDK) to start the Face Verification flow.

post/coe-partner/v1/initiate-flow

Headers

x-onekyc-tokenstring required

IAB Partner token generated using the Get Partner Token API.

x-onboarding-partnerstring required

Used to identify the source of the request. Generated by the IAB team.

x-partner-user-idstring required

User ID of the current session. IAB will tie this info to the resulting submission ID.

x-partner-user-id-typestring required

Detailed type name of the User ID. This can be used to identify the type of user id partner sent to IAB.

x-partner-session-idstring required

Session ID of the current session (generated by partner) that can be used as a correlation ID between the partner and IAB for the submission.

Request body

flow'FACE_VERIFICATION' | 'KTP_SCAN' | 'KYC_LITE' | 'ON_DEMAND_FR' | 'STANDALONE_LIVENESS' required

Specifies which flow to generate the URL/Token for. For face verification this value should be FACE_VERIFICATION.

source'SDK' | 'WEB_SDK' required

Source of the request. SDK uses native/flutter SDK, WEB_SDK uses h5/web.

successRedirectionUrlstring

URL to redirect the user to upon completion of the flow. Mandatory if source is WEB_SDK.

failureRedirectionUrlstring

URL to redirect the user to upon facing any error. Mandatory if source is WEB_SDK.

theme'DARK_MODE' | 'LIGHT_MODE' | 'NO_PREFERENCE'

Theme to use for this flow. Dark and Light theme, with the respective values of DARK_MODE, LIGHT_MODE, and NO_PREFERENCE by default. Default will be NO_PREFERENCE, then it will take from device setting.

Response

Success - Token or Launch URL generated

successboolean