Generate Web View Link for Signing

post

https://onekyc-token.ky.id.gopayapi.com/esign-partner/v2/submissions/generate-web-view-url

Generate a web view URL for signing. Can only be used when metadata.sendNotification is set to false in the confirm upload API. Partners use this to generate signing URLs for their users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userExternalId

string

Digi user ID of the user performing the action. One of userExternalId or email is mandatory

string

Email of the user performing the action. One of userExternalId or email is mandatory for identification. Can also be used for authentication purposes.

phoneNumber

string

Phone number of the user (optional)

authenticationProof

string

JWT token containing authentication proof (optional). JWT should be signed using RSA algorithm and partner's private key. Partner needs to share their public key with GTF.

JWT structure:

requestDetailsHash: SHA-256 hash of {submissionId, partnerSessionId, userExternalId, email}
authenticationDetails: Array of authentication records with verificationTimestamp, authenticationType (EMAIL/PHONE_NUMBER), authenticatedData, and referenceId

Headers

x-onekyc-token

string

required

IAB Partner token generated using the Get Partner Token API.

x-esign-onboarding-partner

string

required

Used to identify the source of the request. Generated by IAB team. Example: For CLIENT_X the value can be CLIENT_X-BE-DOCUMENT_SIGNING_WITH_LLC

x-partner-session-id

uuid

required

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

x-submission-id

uuid

required

Submission ID returned from presigned URL or confirm upload API.

x-user-locale

string

enum

Defaults to id_ID

Default locale for generated web view page. Values: en_ID or id_ID. If not passed, id_ID will be used as default.

Allowed:

Responses

200Web view URL generated successfully

400Invalid request

401Invalid token

403Forbidden

500Internal server error