KBA/OOW (Knowledge Based Authentication/Out of Wallet) Questions via API – Alloy

The API documentation for this process can be found here.

Receiving the KBA/OOW questions

A workflow that includes questions will return the questions as an intermediate step. That is to say, after you send your initial request to the /evaluations endpoint, the response will include the prompts for the OOW questions. That response will look like this:

{
    "evaluation_token": "S-eJ38yUNDqcMxKwwdxbya",
    "error": null,
    "timestamp": 1475258667031,
    "entity_token": "P-Hp6QxEGwNg6sgYNuXdqF",
    "application_token": "token",
    "application_version_id": 11,
    "required": [
        {
            "key": "answers",
            "type": "object",
            "description": "Object containing answers to out of wallet question prompts.",
            "template": {
                "answers": [
                    {
                        "question_id": 1,
                        "answer_id": 0
                    },
                    {
                        "question_id": 2,
                        "answer_id": 0
                    },
                    {
                        "question_id": 3,
                        "answer_id": 0
                    },
                    {
                        "question_id": 4,
                        "answer_id": 0
                    },
                    {
                        "question_id": 5,
                        "answer_id": 0
                    }
                ]
            },
            "optional": [],
            "prompts": {
                "answers": {
                    "questions": [
                        {
                            "id": 1,
                            "question": "What state was your SSN issued in?",
                            "answers": [
                                {
                                    "id": 1,
                                    "answer": "Arkansas"
                                },
                                {
                                    "id": 2,
                                    "answer": "Alabama"
                                },
                                {
                                    "id": 3,
                                    "answer": "West Virginia"
                                },
                                {
                                    "id": 4,
                                    "answer": "Virginia"
                                },
                                {
                                    "id": 5,
                                    "answer": "None Of The Above"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    ]
}

The questions array in the response body will include the questions and answers.

Sending the answers

In order to respond to the questions, you must send a PATCH request to the /evaluations/<evaluation token> endpoint. The evaluation token is found in the initial response above ("evaluation_token": "S-eJ38yUNDqcMxKwwdxbya").

The format of the PATCH request will look like this:

{
  "answers":
      [
        {"question_id": 1, "answer_id": 1},
        {"question_id": 2, "answer_id": 5},
        {"question_id": 3, "answer_id": 2},
        {"question_id": 4, "answer_id": 1},
        {"question_id": 5, "answer_id": 5}
     ]
}

Once the OOW/KBA answers are submitted, you'll receive a final response for your evaluation barring another round of questions - some services can be configured to send multiple rounds. If this is the case, then the subsequent rounds are handled in the exact same way.

Receiving the KBA/OOW questions

Sending the answers

Related articles