Import applicant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

⚠ Mind the following:

  • A 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.

Body Params
string
required

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.
  • You can change the externalUserId by the following method.

string

Source key that helps you group clients that send applicants. Providing sourceKey during import eliminates the need for a separate update API call, helping you avoid redundant two-step flows.

info
object

Contains personal applicant information extracted during verification on your side.

If you later request an applicant check, Sumsub may update this data with information recognized from documents on our side.

fixedInfo
object

Contains information submitted by the applicant.

If you later request an applicant check, Sumsub will not change this information and will use it to cross-validate against data recognized from the applicant’s documents (info).

⚠️ Required to create a company applicant profile.

review
object
required

Explains the details of the applicant verification status and check results obtained on your side.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!