Generate Web View Link for Signing

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

string

Phone number of the user (optional)

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
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: For CLIENT_X the value can be CLIENT_X-BE-DOCUMENT_SIGNING_WITH_LLC

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.

uuid
required

Submission ID returned from presigned URL or confirm upload API.

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

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