Generate Web View URL

This API is used to generate a web view URL for signing or account verification.

post/esign-partner/v2/submissions/generate-web-view-url

Request

  • Base URL
    https://onekyc.ky.id.sandbox.gopayapi.com
  • URL
    https://onekyc.ky.id.sandbox.gopayapi.com/esign-partner/v2/submissions/generate-web-view-url
  • Auth
    none declared. Required headers: x-onekyc-token, x-esign-onboarding-partner, x-partner-session-id, x-submission-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-session-idstring required

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

x-submission-idstring uuid required

Unique identification of submission record

Submission ID generated from GetPresignedUrl API, used to fetch submission details or generate web view URL for an existing submission

Request body

emailstring email required

Email of signer

Response

Successfully initiated flow

successboolean

Example response

{
  "success": true,
  "data": {
    "launchUrl": "https://web-app.staging.goidentitas.id/digisign-mitra/v1/index.html#...."
  }
}

Changes

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