For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Item WebSDK Link

Generates a fresh verification link for a batch row in change_requested. Send the link to the end customer so they can correct data or upload missing documents themselves, without another batch commit.

The link is available only while the row is in change_requested; for any other status the method returns 409.

Endpoint

GET /v2/compliance/batch/{batch_id}/items/{row_key}/web_sdk_link

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

batch_id

string

Batch ID returned by Create Batch.

Yes

"01a0af8b-831f-7dbe-8eaf-459f81998958"

row_key

string

Your row_key from the manifest.

Yes

"client-001"

Headers

Key
Value
Required

Authorization

<JWT>

Yes

Accept

application/json

Yes

Response (200 OK)

Returns a GetItemWebSDKLinkResponse.

Response Fields

Field
Type
Description
Example

url

string

Verification link for the end customer.

"<https://in.sumsub.com/websdk/p/>..."

ttl_seconds

integer

How long the link stays valid, in seconds.

1800

Example Response:


Examples

Request


Error Responses

Errors are returned as {"code", "message", "details"}, where code is a gRPC status code. Use the HTTP status for error handling.

Row Not In change_requested (409) — the row is in any other status:

Item Not Found (404):

Authorization fail (401):


Notes

  • Fresh link every call: request a new link when the previous one expires.

  • Useful for two-sided documents or missing files: when a customer needs to add something only they have, the link is faster than a new batch cycle.

  • Result: once the customer completes the check, the row continues through review and its status updates in Get Batch Item.

Last updated