Permalinks are created manually in cases where you have not yet integrated with Sumsub but still want to let your applicants pass verification. A permalink directs an applicant to the configured verification level, where they can complete the verification flow.

You can create permalinks in the following ways:

• Via Sumsub Dashboard
• Via Sumsub API

How permalinks work

A permalink guides your applicants through the following verification journey:

1. Applicant opens the provided permalink, which directs them to the configured verification level.
2. Applicant provides the required information and completes the verification steps.
3. System processes the verification according to the level’s configuration and customization settings.

Create permalink in Dashboard

You can create two types of permalinks:

• Permalink based on the external applicant ID
• Set of independent permalinks

📘

Note

• Unlike unilinks, each permalink can be used for only one verification (one applicant). Once the verification is completed, the same permalink cannot be reused.
• Applicants who pass identity verification using permalinks will be associated with your API key, allowing you to obtain the applicant data via the Sumsub API or using the Dashboard.

Create one permalink

To create a permalink based on the external user ID:

1. In the Dashboard, open the Integrations page and choose between Individuals and Companies.
2. Find a verification level for which you want to generate a permalink.
   1. Click WebSDK permalinks on the right-hand side of the level record and stay in the Link for ID tab, or
   2. Open the level and click Verification links to create it from inside the level. In the Permalinks tab, use the Specific user section to create it.
3. Set the Language drop-down list to specify the interface language of the verification flow.
4. Provide an External user ID (or use the randomly generated one).
5. In the Link valliduty drop-down list, configure how long the permalink remains active. By default, the link remains valid for 30 minutes, but you can configure the validity period in the range from 30 seconds to 1 month.
6. Click Additional link options, to set up optional fields such as Email, Phone,Customization, SDK translations and so on.
7. Click Generate link to create a permalink.
8. Copy the generated link and share the link with your applicants.

Create set of permalinks

To create a set of independent permalinks:

1. In the Dashboard, open the Integrations page and choose between Individuals and Companies.
2. Find a verification level for which you want to generate permalinks.
   1. Click WebSDK permalinks on the right-hand side of the level record and open the Multiple links tab, or
   2. Open the level and click Verification links to create it from inside the level. In the Permalinks tab, use the External users section to to generate multiple permalinks.
3. Set the Language drop-down list to specify the interface language of the verification flow.
4. In the Link valliduty drop-down list, configure how long the permalink remains active. By default, the link remains valid for 30 minutes, but you can configure the validity period in the range from 30 seconds to 1 month.
5. In the Links count field, specify the number of links to generate.
6. Click Generate multiple links to create a set of permalinks.
7. Copy the generated links and share them with your applicants.

Create permalink via Sumsub API

To create a permalink via the API, use this API method.

curl -X POST \  'https://api.sumsub.com/resources/sdkIntegrations/levels/basic-kyc-level/websdkLink?ttlInSecs=1800&externalUserId=johnDoeId&lang=en' \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '{ }'

Response

A sharable URL is returned.

{
    "url": "https://api.sumsub.com/idensic/l/#/lPDnIKwzmxPfDohk"
}