Actions5
- Applicant Actions
- SDK Integration Actions
Overview
This node integrates with the Sumsub API to manage identity verification applicants. Specifically, the "Applicant" resource with the "Get" operation retrieves detailed information about a specific applicant by their ID.
Common scenarios for this node include:
- Fetching an applicant's profile data during an identity verification workflow.
- Checking applicant details before proceeding with further verification steps.
- Integrating applicant data retrieval into automated compliance or onboarding processes.
For example, after creating an applicant in Sumsub, you can use this node to get their full profile and verify that all required information is present before continuing.
Properties
| Name | Meaning |
|---|---|
| Applicant ID | The unique identifier of the applicant to retrieve. This is a required string input. |
Output
The output JSON contains the full applicant object as returned by the Sumsub API for the specified applicant ID. This typically includes fields such as:
id: The applicant's unique ID.externalUserId: External identifier linked to the applicant.levelName: Verification level assigned.- Contact details like email and phone if available.
- Other metadata related to the applicant's verification status and profile.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Sumsub API (referred generically as an API token and secret).
- The node uses the Sumsub API base URL configured in credentials.
- Proper permissions on the Sumsub account to access applicant data are necessary.
Troubleshooting
Common issues:
- Invalid or missing Applicant ID will cause the API call to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity problems may cause request timeouts or failures.
Error messages:
"The operation "get" is not known!"— indicates an unsupported operation was requested; ensure "Get" is selected."The resource "applicant" is not known!"— indicates an invalid resource selection.- API errors from Sumsub will be passed through; check the error message for details such as "Applicant not found" or "Unauthorized".
Resolutions:
- Verify the Applicant ID is correct and exists in Sumsub.
- Confirm API credentials are valid and have required scopes.
- Check network connectivity and retry if transient errors occur.