Skip to content

SumSub Share Token Guide

This guide explains how to generate a share token from SumSub's API. Use the share token when calling POST /partners/user-token to pass verified users to Gyzer without re-verification.

Official reference: SumSub – Generate share token

Overview

Share tokens are used for Reusable KYC or Copy Applicant flows. After your user completes KYC in your SumSub flow, you call SumSub's API to generate a share token for Gyzer's client ID. You then pass that token to Gyzer's POST /partners/user-token as sumsub_share_token.

Important: Share tokens are invalidated after usage.

Prerequisites

  1. Gyzer's SumSub client ID – Obtain from the Gyzer team
  2. Gyzer configured as recipient – Add Gyzer in SumSub: Reusable identity → Partners → Recipients
  3. Applicant ID – The SumSub applicant who completed KYC
  4. Minimum KYC flow – The applicant must have completed the minimum verification required for provider approval. See Minimum KYC Flow (US) or Minimum KYC Flow (Non-US).

API Endpoint

POST https://api.sumsub.com/resources/accessTokens/shareToken

Request

Headers

Header Value
Content-Type application/json
Authorization Your SumSub API credentials

Body

{
  "applicantId": "63e092c51b7b4030f2e01154",
  "forClientId": "GyzerClientId",
  "ttlInSecs": 600
}
Field Required Description
applicantId Yes SumSub applicant ID (the user who completed KYC)
forClientId Yes Gyzer's SumSub client ID (provided by Gyzer team)
ttlInSecs No Token TTL in seconds (default varies; 600 = 10 minutes)

Example (cURL)

curl --request POST \
  --url https://api.sumsub.com/resources/accessTokens/shareToken \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <your_sumsub_auth>' \
  --data '{
    "applicantId": "63e092c51b7b4030f2e01154",
    "forClientId": "GyzerClientId",
    "ttlInSecs": 600
  }'

Response

{
  "token": "eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTZmODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN1Yi5jb20ifQ.",
  "forClientId": "GyzerClientId"
}
Field Description
token The share token (pass as sumsub_share_token to Gyzer)
forClientId Partner identifier as specified in the request

Note: Treat the token as an opaque string (max 1KB). Do not validate or parse its content; the format may change.

Next Step

Pass the token to Gyzer's Partner API:

{
  "external_user_id": "user_12345",
  "email": "user@example.com",
  "phone": "+1234567890",
  "sumsub_share_token": "<token_from_sumsub_response>"
}

See Embed Widget Guide – SumSub Token Sharing for the full flow.