Actions5
- Applicant Actions
- SDK Integration Actions
Overview
This node integrates with the Sumsub API to update information about an existing applicant in the identity verification system. It allows users to modify key applicant details such as email, phone number, first name, and last name.
Common scenarios where this node is beneficial include:
- Keeping applicant contact information up to date after initial submission.
- Correcting typos or errors in applicant personal data.
- Synchronizing applicant records from other systems into Sumsub.
For example, if a user collects updated contact details from an applicant through a form, this node can be used to push those changes to Sumsub to ensure the verification process uses current data.
Properties
| Name | Meaning |
|---|---|
| Applicant ID | The unique identifier of the applicant whose information you want to update. |
| Update Fields | A collection of fields to update for the applicant. Possible fields: |
| - Email: Applicant's email address | |
| - Phone: Applicant's phone number | |
| - First Name: Applicant's first name | |
| - Last Name: Applicant's last name |
Output
The node outputs a JSON object representing the updated applicant information as returned by the Sumsub API. This typically includes the applicant's ID and any updated fields reflecting the new state after the PATCH request.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Sumsub API.
- Needs proper configuration of the API URL, application token, and secret for signing requests.
- Uses HMAC SHA256 signature for request authentication.
- Relies on n8n's HTTP request helper functions to communicate with the Sumsub REST API.
Troubleshooting
- Invalid Applicant ID: If the provided applicant ID does not exist, the API will likely return an error. Verify that the ID is correct and corresponds to an existing applicant.
- Authentication Errors: Ensure that the API credentials (token and secret) are correctly configured and have sufficient permissions.
- Empty Update Fields: If no fields are specified to update, the request may fail or have no effect. Always provide at least one field to update.
- API Rate Limits: Frequent updates might hit rate limits imposed by Sumsub. Implement retry logic or reduce request frequency if needed.
- Malformed Field Values: Provide valid formats for email and phone fields to avoid validation errors from the API.