checkStatus

4 min

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:

{
    "code":200,
    "msg":"Solicitação realizada com sucesso",
    "data":{
            "statusType":32,
            "extendInfo": "[{\"question\":\"Em qual cidade você nasceu?\",\"options\":
                            [{\"texto\":\"ULIANOPOLIS\",\"id\":1},{\"texto\":\"ARRAIAL\",\"id\":2},{\"texto\":\"TUCANO\",\"id\":3},{\"texto\":\"ITALVA\",\"id\":4},{\"texto\":\"Nenhuma das alternativas\",\"id\":5}],\"id\":363}]",
            "returnCode":null,
            "returnMsg":"User credential error"
     }
}

💡 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:

curl -s -L -X GET 'https://api-testing.klavi.ai/link/external/v2/checkStatus?traceId=yHtj4a0DUAMbgtConQ2B8wxQXpspRvWl' \
-H 'Authorization: K1-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cbms/k1_request, SignedHeaders=content-type;host, Signature=ba08c654a86b932db6b15fa46b69b27c4667d9de013332c99861833796418298' \
-H 'X-Timestamp: 1551113065' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'X-Region: ap-brazil'

Return to the correct example:

{
    "code":200,
    "msg":"Solicitação realizada com sucesso",
    "data":{
        "extendInfo":null,
        "statusType":1,
        "returnCode":403,
        "returnMsg":"Bank service error"
    }
}

Examle of formatting errors:

{
    "code":200,
    "msg":"Solicitação realizada com sucesso",
    "data":{
        "extendInfo":null,
        "statusType":0,
        "returnCode":200,
        "returnMsg":null
    }
}