checkStatus
After credential submission and task initiation, there may be a chance that more user interactions would be required (such as MFA or wrong password input) in order to complete the login process.
Input parameter:
Name | Type | Required | Description |
traceId | String | Yes | The tracking number of the task |
Return data:
Name | Type | Description |
statusType | Number | Task status(See the Status type section of this document) |
extendInfo | String | Extend information returned by institution,see below for a detailed description |
returnCode | Number | The final status of task, this code and message, please refer to the document for details: Return code |
returnMsg | String | The final status message of task |
💡 Note:
In the process of log in institution, some institution may need a token or the password entered by the user is wrong.
In this case, the specific processing logic needs to be determined according to the returned statusType. Extendinfo object will dynamically return different results according to different situations,It could be a string or an array. Partners can also implement the relevant logic according to the specific statusType.
Output sample:
💡 Note:
The "code" in the return result only indicates the final state after the completion of a data collection transaction, which overlaps with the statusType number (1-5). The errorType with the number greater than 5 is the intermediate state of the task, which needs to be handled by partners respectively.
Request example:
Return to the correct example:
Examle of formatting errors: