Sumsub icon

Sumsub

Interact with Sumsub API for identity verification

Actions5

Overview

This node integrates with the Sumsub API to create a new applicant for identity verification purposes. It is useful in scenarios where you need to onboard users or customers by verifying their identity through a third-party service. For example, financial institutions, marketplaces, or any platform requiring KYC (Know Your Customer) compliance can use this node to submit applicants for verification.

The "Create Applicant" operation allows you to register a new applicant by providing an external user ID, specifying the verification level, and optionally including additional contact details like email and phone number. This helps initiate the identity verification workflow on the Sumsub platform.

Properties

Name Meaning
External User ID The unique identifier of the user in your own system, used to link your data with Sumsub.
Level Name The name of the verification level to apply to the applicant (e.g., basic, advanced).
Additional Fields Optional extra information about the applicant:
- Email Applicant's email address.
- Phone Applicant's phone number.
- Source Key A string to group clients sending applicants, useful for categorization or filtering.

Output

The node outputs a JSON object representing the newly created applicant as returned by the Sumsub API. This typically includes fields such as the applicant's ID within Sumsub, status, and other metadata related to the verification process.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "sumsub-applicant-id",
  "externalUserId": "your-external-user-id",
  "levelName": "basic",
  "email": "applicant@example.com",
  "phone": "+1234567890",
  "status": "pending"
}

Dependencies

  • Requires an API key credential for authenticating with the Sumsub API.
  • The node uses HMAC SHA256 signing for request authentication.
  • The Sumsub API base URL and credentials must be configured in n8n.
  • Network access to the Sumsub API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect levelName values may result in API errors if the specified verification level does not exist.
    • Missing required parameters like externalUserId or levelName will cause validation errors.

  • Error messages:

    • "The operation \"create\" is not known!" — indicates an unsupported operation was requested; ensure the operation name is correct.
    • "The resource \"applicant\" is not known!" — indicates an invalid resource name; verify the resource parameter.
    • API response errors from Sumsub (e.g., 400 Bad Request) usually include descriptive messages; check that all required fields are correctly set.

  • Resolution tips:

    • Double-check API credentials and permissions.
    • Validate input parameters before execution.
    • Review Sumsub API documentation for valid verification levels and field formats.

Links and References

Discussion