JobInformation

Guid-type JobID

SuccessFlag is Null when the job is still in progress. SuccessFlag will change to "True" when the job completes successful. SuccessFlag will change to "False" when the job fails.

SecurityQuestion field contains one ore more security questions asked by the institution. E.g. the SecurityQuestion field in the Job can be as following: "['what is your favorite color?', 'what is your favorite fruit?']"

Use api/Job/UpdateJobSecurityAnswer method to provide user's security answers to the job.

If the institution requests to send a security token for authentication and the user has registered different delivery methods to receive such token, the "TokenMethod" field in the job will not be empty. E.g. "TokenMethod" field can be as following: '["Email me at s*****@gmail.com", "Send verification code by voice call to ***-***-3800"]'

Use api/Job/UpdateJobTokenInput method to choose a delivery method

Once the institution sends out a security token via the delivery method chosen by the user, the "TokenSentFlag" field in the job will change to "True".

Once the TokenSentFlag is set to "1", the "TokenInputName" field in the job indicate what type of token it is. E.g. Token indicates one-time token; PIN indicates personal pin.

Use api/Job/UpdateJobTokenInput method to enter the security token received by the user.

If the institution calls the user and asks user to read or type the security token shown on the screen for authentication, the "TokenRead" field in the job will show the security token shown on the webpage screen. E.g. "TokenRead" field can be as following: "123456".

Once user reads or types the security token over the phone, she will be reminded to click the "Verify Phone" button on the screen to proceed with login. Use api/Job/UpdateJobTokenInput method to update the "VerifyPhoneFlag" field in the job to proceed with login process.

If the institution requests user to read a captcha image, the captcha image is stored as a Base64 string in "CaptchaImage" field in the job.

Use api/Job/UpdateJobCaptchaInput method to update the job with texts or numbers read in the captcha image.

As the job proceeds, the "LastStep" field shows which step the job is at, e.g. "LogInPanel" shows that the job just passes the login panel step. If the job fails, "LastStep" indicates at which step the job fails. "LastStep" includes steps such as: "LogInPanel", "SecurityQuestionPanel", "TokenMethods", "TokenInput", "AccountList", "AccountSummary", "TransactionTable", "DownloadDialog".

As the job proceeds, the "LastStatus" field indicates the status of the job at the current step, e.g. "Completed" indicates the job completes the step shown in "LastStep". If the job fails, "LastStatus" indicates how the job fails at the last step, e.g. "Timeout" means the job times out at the last step.