Create applicant

Verification level name. The level determines the verification steps the applicant must complete and the documents that are required for verification.

⚠ Mind the following:

• The level has to be created in the same environment. For example, in the Sandbox mode, you may not be able to use a level configured to be only available in the Production environment.
• A level name is case-sensitive. Kyc-level and kyc-level are considered as completely different level names. The system does not allow creating an applicant with the level name that does not exist.
• If a level name contains reserved characters (for example, @, +, white spaces as %20), it should be URL-encoded, otherwise you may get a signature mismatch.
• The system does not allow creating a company profile with a level for individuals and vice versa.

Access token previously generated for the Device Intelligence flow.

Unique applicant identifier as registered on your side.

• This identifier can be used to get the applicant data in case the applicantId in the Sumsub system is unknown to you.
• When creating an applicant, you can generate and add the externalUserId manually, or it will be automatically generated and added by Sumsub. If it is generated by Sumsub, the preview-random-someUniqueUserId format will be used.
• You can change the externalUserId by the following method.
• Max 512 characters.

Source key that helps you group clients that send applicants.

Applicant email address.

It is mandatory if the email verification is required. If not provided, the applicant cannot receive verification status emails.

Applicant phone number.

It is mandatory if the phone verification is required.

Two-letter code of the language (ISO 639-1 format, for example, en, fr, de) for the SDK and emails sent to the applicant.

The verification results should be displayed to the applicant in this language as well. As a rule, it is detected by the applicant IP address. You can set the language when creating an applicant or initializing the SDK (MSDK).

Applicant type.

This field is not a mandatory one when creating an applicant. It will be automatically added depending on the level you assign.