Interface: ApplicantsChangeTopLevelInformationRequest
Describes the structure of the request for the applicantsChangeTopLevelInformation method
Work with applicants
deleted
• Optional deleted: boolean
Marks an applicant as inactive if set to true. The applicant will not be considered a duplicate. SDKs will not initiate checks for this applicant.
See
Change top-level information API Reference
Defined in
email
• Optional email: string
A new email address that you want to assign to the given applicant.
See
Change top-level information API Reference
Defined in
externalUserId
• Optional externalUserId: string
An external applicant identifier.
See
Change top-level information API Reference
Defined in
id
• id: string
A unique applicant identifier.
See
Change top-level information API Reference
Defined in
lang
• Optional lang: string
The language, in which the applicant should see the verification results.
See
Change top-level information API Reference
Defined in
metadata
• Optional metadata: unknown
Additional information about the applicant.
See
Change top-level information API Reference
Defined in
phone
• Optional phone: string
A new phone number that you want to assign to the given applicant.
See
Change top-level information API Reference
Defined in
questionnaires
• Optional questionnaires: unknown
A questionnaire configuration with answers.
See
Change top-level information API Reference
Defined in
sourceKey
• Optional sourceKey: string
A new source key that you want to assign to the given applicant.
See
Change top-level information API Reference