Generate share token (query parameters)

Generates a new share token for Reusable KYC using query parameters.

Overview

Use this method to create a new share token for Reusable KYC using query parameters.

❗️

Important

Share tokens are invalidated after importing applicants.

Request example

curl --request POST \
     --url 'https://api.sumsub.com/resources/accessTokens/-/shareToken?applicantId=63edf432a3e0fc4916d678f3&forClientId=CoolCoinLtd&ttlInSecs=600'

Response explained

In the response, you will get a new share token.

The following fields are returned:

FieldDescription
tokenThe share token generated upon execution of the request.
forClientIdA unique partner identifier as specified in the request.

The following is a response example:

{
  "token": "eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTZmODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN1Yi5jb20ifQ.",
  "forClientId": "CoolCoinLtd"
}

📘

Note

Make sure your integration code does not validate or analyze the access token content, as the format is not fixed and may undergo further changes in the future. The token must be treated as an arbitrary string with the maximum length of 1KB.

Language
Authorization
Header
Click Try It! to start a request and see the response here!