Interface InitiateAccountVerificationRequest

interface InitiateAccountVerificationRequest {
    accept_language?: string;
    client_id?: string;
    email?: string;
    mobile?: string;
    name?: string;
    phone?: string;
    processingType?: ProcessingType;
    redirect_uri?: string;
    requestId?: string;
    response_type?: string;
    sub?: string;
    templateKey?: string;
    username?: string;
    verificationMedium?: string;
}

Properties

accept_language? client_id? email? mobile? name? phone? processingType? redirect_uri? requestId? response_type? sub? templateKey? username? verificationMedium?

Properties

Optionalaccept_language

accept_language?: string

Response language, which is configured in cidaas admin ui

Optionalclient_id

client_id?: string

Unique identifier of client app, can be found in app setting under admin ui

Optionalemail

email?: string

email of user

Optionalmobile

mobile?: string

mobile number of user

Optionalname

name?: string

name of user

Optionalphone

phone?: string

phone number of user

OptionalprocessingType

processingType?: ProcessingType

can be either CODE, LINK, or GENERAL

Optionalredirect_uri

redirect_uri?: string

Specify the url where the user needs to be redirected after successful login

OptionalrequestId

requestId?: string

Request id returned from the authorization call

Optionalresponse_type

response_type?: string

response type expected for the process

Optionalsub

sub?: string

Subject (User) identifier

OptionaltemplateKey

templateKey?: string

Refers to a template or predefined message/key associated with the opt-in reminder.

Optionalusername

username?: string

username of user

OptionalverificationMedium

verificationMedium?: string

described which medium (email, mobile, username) to be used for verifying user

Settings

Member Visibility

On This Page

Properties