Jump to

• Request
• Response
• Examples

Get questions of the user.

get

/oaa-kba/runtime/kba/v1/questions

Since 12.2.1.4.1-20230630, this method is deprecated. Questions that are associated with the user are returned. If user information is present, questions associated with the user is returned. These are questions preselected by the system to be used for KBA challenge.

Request

Query Parameters

• group: string
  group of user for whom questions will be fetched.
• userid: string
  userid of user for whom questions will be fetched.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : QuestionsResponse

Type: object

Show Source

• choices: array choices
• message: string
  Message related to the status of the request
• status: string
  Status of the request

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "choices":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Choice"
            }
        }
    }
}

Nested Schema : choices

Type: array

Show Source

• Array of: object Choice

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Choice"
    }
}

Nested Schema : Choice

Type: object

Show Source

• questions: array questions

{
    "type":"object",
    "properties":{
        "questions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Question"
            }
        }
    }
}

Nested Schema : questions

Type: array

Show Source

• Array of: object Question

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Question"
    }
}

Nested Schema : Question

Type: object

Show Source

• active: boolean
  Default Value: true

  If true, this question is associated with user and will be used to challenge the user.
• answer: string
  User's answer to question associated with user
• question: string
  question text associated with user
• questionId: integer (int64)
  unique identifier of question associated with user

{
    "required":[
        "questionid"
    ],
    "type":"object",
    "properties":{
        "questionId":{
            "type":"integer",
            "description":"unique identifier of question associated with user",
            "format":"int64"
        },
        "question":{
            "type":"string",
            "description":"question text associated with user"
        },
        "answer":{
            "type":"string",
            "description":"User's answer to question associated with user"
        },
        "active":{
            "type":"boolean",
            "description":"If true, this question is associated with user and will be used to challenge the user.",
            "default":true
        }
    }
}

401 Response

Unauthorized. User credentials invalid or not provided.

Body ()

Root Schema : KBAAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

422 Response

failed to get user questions for requested user.

Body ()

Root Schema : KBAAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

500 Response

Server error.

Body ()

Root Schema : KBAAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows a sample request and response for retrieving questions associated with a user. The questions associated with the user are returned if the user information is present. The system has preselected these questions to be used for the KBA challenge.

cURL Command to Retrieve a List of Questions

curl --location --request GET '<OAAService>/oaa-kba/runtime/kba/v1/questions?userid=user1&group=Default' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data ''

Sample Response

{
    "status": "0",
    "message": "Successfully processed the request.",
    "choices": [
        {
            "questions": [
                {
                    "questionId": 2,
                    "question": "What was your father's profession when you were born?",
                    "active": false
                },
                {
                    "questionId": 41,
                    "question": "What was the last name of your favorite teacher in High School?",
                    "active": false
                },
                {
                    "questionId": 5,
                    "question": "What is the first name of your mother's eldest sibling?",
                    "active": false
                },
                {
                    "questionId": 33,
                    "question": "How much did you pay for your first car?",
                    "active": false
                },
                {
                    "questionId": 17,
                    "question": "What was the first name of your first boss?",
                    "active": false
                }
            ]
        },
        {
            "questions": [
                {
                    "questionId": 87,
                    "question": "What was the name of your favorite childhood musical group?",
                    "active": false
                },
                {
                    "questionId": 50,
                    "question": "What was your youngest child's birth weight?",
                    "active": false
                },
                {
                    "questionId": 126,
                    "question": "What year was your favorite Super Bowl?",
                    "active": false
                },
                {
                    "questionId": 23,
                    "question": "What was your first sweetheart's first name?",
                    "active": false
                },
                {
                    "questionId": 54,
                    "question": "What breed was your first dog?",
                    "active": false
                }
            ]
        },
        {
            "questions": [
                {
                    "questionId": 60,
                    "question": "What is your best friend's birthday?",
                    "active": false
                },
                {
                    "questionId": 3,
                    "question": "What was your birth weight?",
                    "active": false
                },
                {
                    "questionId": 42,
                    "question": "What was the last name of your favorite professor in college?",
                    "active": false
                },
                {
                    "questionId": 6,
                    "question": "What is your maternal grandfather's first name?",
                    "active": false
                },
                {
                    "questionId": 34,
                    "question": "What year did you purchase your first car?",
                    "active": false
                }
            ]
        }
    ]
}
}

Back to Top