Create applicant action

post/resources/applicantActions/-/forApplicant/{applicantId}

Request

Path parameters

applicantIdstring required

Unique applicant identifier in the Sumsub system. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard. <br><br>If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Query parameters

levelNamestring required

Verification level name. The level determines the verification steps the applicant must complete and the documents that are required for verification. <br><br>⚠ Mind the following: <ul><li>The level must be of the <b>Applicant action</b> type. Otherwise, you will get a 400 error saying "Level is not suitable for actions".</li><li>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.</li><li>A level name is case-sensitive. <code>Kyc-level</code> and <code>kyc-level</code> are considered as completely different level names. The system does not allow creating an applicant with the level name that does not exist.</li><li>If a level name contains reserved characters (for example, <code>@</code>, <code>+</code>, white spaces as <code>%20</code>), it should be URL-encoded, otherwise you may get a signature mismatch.</li></ul>

Request body

externalActionIdstring required

Unique identifier of the applicant action on your side.<br><br>⚠️ This value must be unique across your entire account — reusing an externalActionId for a different applicant action (whether for the same applicant or a different one) causes the request to be rejected.

emailstring

Applicant email address.<br><br>It is mandatory if the email verification is required. If not provided, the applicant cannot receive verification status emails.

phonestring

Applicant phone number.<br><br>It is mandatory if the phone verification is required.

Changes

No recorded changes to this operation across all 2 revisions of this API.