API References
Create AccountSubmit Feedback

Initiate Flow

post
https://onekyc-token.staging.gopayapi.com/esign-partner/v1/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Specifies which flow to use

Allowed:
string
enum
required

Specifies which source the partner uses

Allowed:
string

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

string

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

additionalDetails
object
Headers
string
required

IAB Partner token generated using the Get Partner Token API

string
required

Used to identify the source of the request. Generated by IAB team. Example: CLIENT_X-WEB_SDK-STANDALONE_IDENTITY_VERIFICATION

string
required

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

string
required

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

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.

Responses

Updated 20 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago