API References
Create AccountSubmit Feedback

Initiate Verification Flow

post
https://onekyc.ky.id.sandbox.gopayapi.com/coe-partner/v1/initiate-flow

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

Body Params
string
enum
required

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

Allowed:
string
enum
required

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

Allowed:
string

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

string

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

string
enum
Defaults to 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.

Allowed:
additionalDetails
object

Additional details sent in the request, depending on Flow and Source.

Headers
string
required
Defaults to YOUR_ONEKYC_TOKEN

IAB Partner token generated using the Get Partner Token API.

string
required
Defaults to PARTNER_CODE-PLATFORM-FLOW

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

string
required
Defaults to UNIQUE_USER_ID

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

string
required
Defaults to USER_ID_TYPE

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

string
required
Defaults to UNIQUE_SESSION_ID

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.

Responses

Updated about 1 month ago

Documentations
Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago 
Documentations