Generate Sumsub ID share link

Overview

Use this method to request a share link before opening the share consent screen for the Sumsub ID Connect – Partner sharing.

Request example

curl --request POST \
     --url https://api.sumsub.com/resources/snsId/oauth/shareLink \
     --header 'Authorization: Bearer token' \
     --data '{
             "redirectUri": "<your_redirect_uri>",
             "forClientId": "CoolCompanyLtd",
             "displayMode": "page",
             "state": "<your_custom_state>"
         }'

Response explained

Sumsub validates the request, checks redirectUri against the allowlist, and generates a share page URL.

🚧

Attention

The generated link expires in 5 minutes.

Response example

{
  "link": "https://id.sumsub.com/share/<link_id>"
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!