Actions5
- Applicant Actions
- SDK Integration Actions
Overview
This node interacts with the Sumsub API to generate a WebSDK link for identity verification purposes. Specifically, the "Generate WebSDK Link" operation under the "SDK Integration" resource creates a secure URL that can be embedded or shared with users to initiate a verification process at a specified verification level.
Common scenarios where this node is beneficial include:
- Embedding identity verification flows into web or mobile applications.
- Generating time-limited verification links for external users.
- Customizing verification requests with user identifiers and contact details.
For example, a company might use this node to generate a verification link for a new user signing up on their platform, specifying the verification level and user ID, optionally including email or phone number, and setting how long the link remains valid.
Properties
| Name | Meaning |
|---|---|
| Level Name | The name of the verification level to apply (e.g., "basic", "advanced"). |
| User ID | External identifier for the user who will perform the verification. |
| Additional Fields | Optional extra parameters: |
| Applicant's email address. | |
| - Phone | Applicant's phone number. |
| - TTL In Seconds | Time-to-live for the generated link in seconds (default 1800). |
| - External Action ID | A specific action identifier to associate with the verification request. |
Output
The node outputs a JSON object containing the response from the Sumsub API after generating the WebSDK link. This typically includes:
- The generated WebSDK link URL that can be used to start the verification process.
- Metadata such as expiration time or related identifiers if provided by the API.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"websdkLink": "https://example.sumsub.com/sdk?token=abc123",
"ttlInSecs": 1800,
"externalActionId": "action_456"
}
Dependencies
- Requires an API key credential for authenticating with the Sumsub API.
- Needs network access to the Sumsub API endpoint.
- The node expects configuration of credentials providing:
- An application token.
- An application secret used for HMAC signature generation.
- No additional environment variables are required beyond standard n8n credential setup.
Troubleshooting
- Invalid Credentials Error: If authentication fails, verify that the API token and secret are correctly configured and have sufficient permissions.
- Unknown Operation or Resource: Errors indicating unknown operations or resources suggest misconfiguration of the node parameters; ensure "Resource" is set to "SDK Integration" and "Operation" to "Generate WebSDK Link".
- Missing Required Parameters: The node requires "Level Name" and "User ID". Omitting these will cause errors.
- Expired or Invalid Link: If the generated link does not work, check the TTL parameter and ensure it is within acceptable limits.
- Network Issues: Connectivity problems to the Sumsub API will result in request failures; verify network access and proxy settings if applicable.