MImidtrans

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

Request

  • Base URL
    https://onekyc.ky.id.sandbox.gopayapi.com
  • URL
    https://onekyc.ky.id.sandbox.gopayapi.com/esign-partner/v1/initiate-flow
  • Auth
    none declared. Required headers: x-onekyc-token, x-esign-onboarding-partner, x-partner-user-id, x-partner-user-id-type, x-partner-session-id

Headers

x-onekyc-tokenstring required

OneKYC Partner token generated using the Get Partner Token API

x-esign-onboarding-partnerstring required

Used to identify the source of the request (generated by OneKYC team)

x-partner-user-idstring required

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

x-partner-user-id-typestring required

Detailed name of the User ID. OneKYC will tie this info to the resulting submission ID

x-partner-session-idstring required

Session ID (generated by partner) used as correlation ID between partner and OneKYC. Must be unique for each invocation

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.