POST api/Job/UpdateJobTokenInput

If the institution requests to send a security token for authentication, use this method to update the job with required information at each step of the token verification process.

Request Information

URI Parameters

None.

Body Parameters

UpdateJobByTokenParams
NameDescriptionTypeAdditional information
JobID

Guid-type JodID

globally unique identifier

None.

TokenChoice

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 this method to update the job with user's chosen delivery method, e.g. Set TokenChoice to "Email me at s*****@gmail.com" Note: only one delivery method can be chosen, TokenChoice string must equal one of the method's string listed in the "TokenMethod" field.

string

None.

TokenInput

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". Use this method to update the job with user's received security token, e.g. Set TokenInput to "123456"

string

None.

VerifyPhoneFlag

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 this method to update the "VerifyPhoneFlag" field in the job to "True" to click the "Verify Phone" button and proceed with login process. Note: "VerifyPhoneFlag" is of boolean type and only accepts "True" as the input value.

boolean

None.

Request Formats

application/json, text/json

Sample:
When "TokenMethod" shows "[\"call xxx-xxx-1234\", \"text xxx-xxxx-1234\"]", choose a token delivery method: 
{ 
 "JobID": "e67b47d2-06a8-46ee-9fba-ec576873bbce",
 "TokenChoice": "call xxx-xxx-1234" 
}
When "TokenSentFlag" field is true, enter token received: 
{ 
 "JobID": "e67b47d2-06a8-46ee-9fba-ec576873bbce",
 "TokenInput": "56789" 
}
Or when receiving a call from the bank, read out the token shown in "TokenRead" field and update "VerifyPhone" field to true: 
{ 
 "JobID": "e67b47d2-06a8-46ee-9fba-ec576873bbce",
 "VerifyPhoneFlag": true 
}

application/xml, text/xml

Sample:
Coming soon.

Response Information

Resource Description

0 for success, -1 for failure

TransmitStatusEnums

Response Formats

application/json, text/json

Sample:
0

application/xml, text/xml

Sample:
Coming soon.