Get a Task Status

4min

Get a task status by taskId
GET
Request
Path Params
taskId
required
String
Unique identifier for the task
Header Parameters
Authorization
required
String
Bearer link token, it returned by the /links
Curl
curl --location --globoff 'https://api-sandbox.klavi.ai/data/v1/tasks/{taskId}/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api-sandbox.klavi.ai/data/v1/tasks/{taskId}/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
{
  "code":200,
  "message":"ok",
  "status": "success",
  "mfaInfo": object,
}
{
  "code":200,
  "message":"ok",
  "status": "success",
  "mfaInfo": object,
}
﻿
Response
Name
Descritption
code
The status of task, only valid when the status is fail, other is 200, the error code and message, please refer to the document for details: Open Data Codes and Errors﻿﻿
message
Only valid when the status is fail, other is ok
status
Verify the status of MFA, the enumeration values are: success，fail , needMFA and pending
If you want to customize error messages, please first check the status as fail before proceeding with customization based on the code number.
mfaInfo
Only valid when the status is needMFA
MFA Type
JSON
{
  "mfaId": 22
  "mfaType":"basic"
}
{
  "mfaId": 22
  "mfaType":"basic"
}
﻿
JSON
{
  "mfaId": 30,
  "mfaType":"contact",
  "contact":"phone"
}
{
  "mfaId": 30,
  "mfaType":"contact",
  "contact":"phone"
}
﻿
Example:
JSON
{
  "mfaId": 30,
  "mfaType":"contact",
  "contact":"(99)*****-1234"
}
{
  "mfaId": 30,
  "mfaType":"contact",
  "contact":"(99)*****-1234"
}
﻿
JSON
{
    "mfaId": 32,
    "mfaType":"questions",
    "questions":[
        {
            "id":"100",
            "question":"test",
            "options":[
                {
                    "label":"xxx",
                    "value":"1"
                }
            ]
        }
    ]
}
{
    "mfaId": 32,
    "mfaType":"questions",
    "questions":[
        {
            "id":"100",
            "question":"test",
            "options":[
                {
                    "label":"xxx",
                    "value":"1"
                }
            ]
        }
    ]
}
﻿
Example:
JSON
{
    "mfaId": 32,
    "mfaType":"questions",
    "questions":[
        {
            "id":"100",
            "question":"Em qual desses municipios você reside ou já residiu?",
            "options":[
                {
                    "label":"BURITI DOS MONTES",
                    "value":"1"
                },
                {
                    "label":"SAO GONCALO DO GURGUEIA",
                    "value":"2"
                },
                {
                    "label":"Nenhuma das alternativas",
                    "value":"3"
                },
                {
                    "label":"SAO PEDRO DA CIPA",
                    "value":"4"
                },
                {
                    "label":"SAO PAULO",
                    "value":"5"
                }
            ]
        }
    ]
}
{
    "mfaId": 32,
    "mfaType":"questions",
    "questions":[
        {
            "id":"100",
            "question":"Em qual desses municipios você reside ou já residiu?",
            "options":[
                {
                    "label":"BURITI DOS MONTES",
                    "value":"1"
                },
                {
                    "label":"SAO GONCALO DO GURGUEIA",
                    "value":"2"
                },
                {
                    "label":"Nenhuma das alternativas",
                    "value":"3"
                },
                {
                    "label":"SAO PEDRO DA CIPA",
                    "value":"4"
                },
                {
                    "label":"SAO PAULO",
                    "value":"5"
                }
            ]
        }
    ]
}
﻿
JSON
{
    "mfaId": 51,
    "mfaType":"multiChoice",
    "multiChoices":[
        {
            "label":"xxx",
            "value":"1"
        }
    ]
}
{
    "mfaId": 51,
    "mfaType":"multiChoice",
    "multiChoices":[
        {
            "label":"xxx",
            "value":"1"
        }
    ]
}
﻿
Example:
JSON
{
    "mfaId": 51,
    "authMethod":"multiChoice",
    "multiChoices":[
        {
            "label":"E-mail",
            "value":"1"
        },
        {
            "label":"SMS",
            "value":"2"
        }
    ]
}
{
    "mfaId": 51,
    "authMethod":"multiChoice",
    "multiChoices":[
        {
            "label":"E-mail",
            "value":"1"
        },
        {
            "label":"SMS",
            "value":"2"
        }
    ]
}
﻿
﻿

Name	Descritption
code	The status of task, only valid when the status is fail, other is 200, the error code and message, please refer to the document for details: Open Data Codes and Errors
message	Only valid when the status is fail, other is ok
status	Verify the status of MFA, the enumeration values are: success，fail , needMFA and pending If you want to customize error messages, please first check the status as fail before proceeding with customization based on the code number.
mfaInfo	Only valid when the status is needMFA

Updated 29 Sep 2024

Did this page help you?

Submit MFA Data

Update User Data