post https://api.sumsub.com/resources/accessTokens/sumsubIdShareToken
Overview
Use this method to obtain a Sumsub ID share token so as to share the Sumsub ID profile with your partner as described in Sumsub ID Connect.
Note
By default, the Sumsub ID share token expires after 1800 seconds, unless otherwise specified in the request.
Request example
curl -X POST \
'https://api.sumsub.com/resources/accessTokens/sumsubIdShareToken' \
-H 'content-type: application/json' \
-d '{
"sumsubIdConnectToken": "snd-id-con-a-WRT7FRBRfdejpsDR8a_cYeX9BU32QP_I_Hyc93saZcg5965PfGzrHGDEdrTRseop",
"forClientId": "CoolCompanyLtd",
"ttlInSecs": "1800"
}'
Response explained
In the response, you will get a new Sumsub ID share token.
The following fields are returned:
| Field | Type | Description |
|---|---|---|
token | String | The share token generated upon execution of the request. |
forClientId | String | Unique partner identifier as specified in the request. |
Response examples
If the request is successfully sent and processed, you will get a response like the one below.
{
"token": "trERdsIUjkJub25lIn0.eyJqdGkiOijfltYRDespODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN14hdtERwoFD.",
"forClientId": "CoolCompanyLtd"
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "acd9fed2554d53a5a49ccbdhtu57jg87",
"description": "'forClientId' and 'sumsubIdConnectToken' must be provided for creating Sumsub ID share token"
}