Actions5
- Applicant Actions
- SDK Integration Actions
Overview
This node integrates with the Sumsub API, a service for identity verification and applicant management. Specifically, the "Applicant" resource with the "Get Status" operation retrieves the current verification status of an applicant by their ID.
Common scenarios include:
- Checking the verification progress or final result of an identity check for a user in onboarding workflows.
- Automating decision-making based on the applicant's verification status (e.g., approve, reject, or request more info).
- Monitoring compliance and KYC (Know Your Customer) processes in financial services, marketplaces, or any platform requiring verified identities.
Example: After submitting an applicant for verification, you can use this node to periodically fetch their status and trigger follow-up actions depending on whether they are approved or require additional documents.
Properties
| Name | Meaning |
|---|---|
| Applicant ID | The unique identifier of the applicant whose verification status you want to retrieve. |
Output
The node outputs a JSON object representing the applicant's current status as returned by the Sumsub API. This typically includes fields such as:
- Overall verification status (e.g., "pending", "approved", "rejected").
- Details about individual checks or steps completed.
- Timestamps or metadata related to the verification process.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Sumsub API.
- Needs configuration of the API URL, application token, and secret for request signing.
- Uses HMAC SHA256 signature for securing API requests.
- Relies on n8n's HTTP request helper functions to communicate with the Sumsub REST endpoints.
Troubleshooting
- Invalid Applicant ID: If the provided applicant ID does not exist or is malformed, the API will return an error. Verify the ID correctness.
- Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Ensure the API token and secret are correctly configured.
- Network Issues: Connectivity problems may lead to request timeouts or failures. Check network access to the Sumsub API endpoint.
- API Rate Limits: Excessive requests might be throttled by the Sumsub API. Implement retry logic or respect rate limits.
- Unexpected Response Structure: If the API changes, the node output structure might differ. Review API documentation for updates.
Links and References
- Sumsub API Documentation
- Sumsub Identity Verification Overview
- n8n HTTP Request Node Documentation (for understanding underlying request handling)