Interface: ApplicantsCreateApplicantRequest
Describes the structure of the request for the SumsubClient.applicantsCreateApplicant method
Work with applicants
email
• Optional email: string
An applicant email address.
See
Create applicant API Reference
Defined in
externalUserId
• externalUserId: string
A unique applicant identifies on the client side.
See
Create applicant API Reference
Defined in
fixedInfo
• Optional fixedInfo: ApplicantsCreateApplicantFixedInfoValue
Contains information submitted by the applicant via Web or Mobile SDK or by you using this method. Used to compare the data that you provide to us with that we extract from the applicant documents.
See
Create applicant API Reference
Defined in
info
• Optional info: ApplicantsCreateApplicantInfoValue
Contains information recognized and extracted from the applicant documents solely by Sumsub.
See
Create applicant API Reference
Defined in
lang
• Optional lang: string
The language, in which the verification results should be displayed to applicants. Requires the ISO 639-1 format.
See
Create applicant API Reference
Defined in
levelName
• levelName: string
A verification level name. Case-sensitive and has to be created in the same environment. If contains reserved characters (e.g., @, +", white spaces as %20), it should be URL-encoded, otherwise you may get signature mismatch.
See
Create applicant API Reference
Defined in
metadata
• Optional metadata: unknown
Additional information not displayed to the end-user. For example: [{"key": "keyFromClient", "value": "valueFromClient"}].
See
Create applicant API Reference
Defined in
phone
• Optional phone: string
An applicant phone number.
See
Create applicant API Reference
Defined in
sourceKey
• Optional sourceKey: string
A source key that helps you group clients.
See
Create applicant API Reference
Defined in
type
• Optional type: string
An applicant type (company, individual).
See
Create applicant API Reference