Sign in

v1

latestOpenAPI 3.1.02026-07-263847150.4 KB
Flow

Initiate Flow

Fetch the user token/launch URL needed to start the identity verification flow on frontend. Additional details passed in this API will be stored and used during submission processing.

post/esign-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 IAB team. Example: CLIENT_X-WEB_SDK-STANDALONE_IDENTITY_VERIFICATION

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 name of the User ID. IAB will tie this info to the resulting submission ID.

x-partner-session-idstring uuid required

Session ID of the current session (generated by partner) that can be used as a correlation ID. Should be uniquely generated for each invocation. Acts as idempotency ID between Partner BE and IAB BE.

Request body

flow'STANDALONE_IDENTITY_VERIFICATION' required

Specifies which flow to use

source'SDK' | 'WEB_SDK' required

Specifies which source the partner uses

successRedirectionUrlstring

URL where user will be redirected upon successful completion (required if source = WEB_SDK)

failureRedirectionUrlstring

URL where user will be redirected if flow fails (required if source = WEB_SDK)

Example request

{
  "additionalDetails": {
    "email": "abc@xyz.com",
    "phoneNumber": "628188888889"
  }
}

Response

Successfully initiated flow

OR

Example response

{
  "success": true,
  "data": {
    "expirySeconds": "5184000",
    "expiresAt": "1746253972"
  }
}