Skip to content

kbaQuestions

Query

Spinwheel user verification/consent KBA questions for a customer (step 1 of 2)

Query Signature

query {
kbaQuestions(input: KbaQuestionsInput!): KbaQuestionsResponse!
}

Example Request

query KbaQuestions($input: KbaQuestionsInput!) {
kbaQuestions(input: $input) {
# Add fields you want to retrieve
}
}

Example Variables:

{
"input": {
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-03-15",
"ssn": "123456789",
"addressLine1": "123 Main Street",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"reqOrgContactId": "contact-12345"
}
}

Example Response

{
"data": {
"kbaQuestions": {
"data": {
"questions": [
{
"id": "q1",
"question": "Which of the following addresses have you been associated with?",
"options": [
{
"id": "q1-a",
"text": "123 Oak Street"
},
{
"id": "q1-b",
"text": "456 Pine Avenue"
},
{
"id": "q1-c",
"text": "789 Maple Drive"
},
{
"id": "q1-d",
"text": "None of the above"
}
]
},
{
"id": "q2",
"question": "What county is associated with the address 123 Main Street?",
"options": [
{
"id": "q2-a",
"text": "Los Angeles County"
},
{
"id": "q2-b",
"text": "Orange County"
},
{
"id": "q2-c",
"text": "San Diego County"
},
{
"id": "q2-d",
"text": "None of the above"
}
]
},
{
"id": "q3",
"question": "Which of the following vehicles have you owned or leased?",
"options": [
{
"id": "q3-a",
"text": "2018 Honda Accord"
},
{
"id": "q3-b",
"text": "2020 Toyota Camry"
},
{
"id": "q3-c",
"text": "2019 Ford F-150"
},
{
"id": "q3-d",
"text": "None of the above"
}
]
}
]
},
"errors": null
}
}
}

Arguments

ArgumentTypeDescription
inputKbaQuestionsInput!Input containing customer identity and address information for KBA verification

Input Types

KbaQuestionsInput

Input for KBA question request

Required Fields:

FieldTypeDescription
firstNameString!customer first name
lastNameString!customer last name
dateOfBirthString!dob in yyyy-mm-dd format 1990-04-12
ssnString!Contact SSN without hyphens
addressLine1String!Customer address info
cityString!Customer address info
stateString!Customer address info
zipString!Customer address info
reqOrgContactIdString!Requesting organization contact ID

Optional Fields:

FieldTypeDescription
addressLine2StringCustomer address info
zipExtensionStringCustomer address info

Response Type

Returns: KbaQuestionsResponse!

KbaQuestionsResponse

KBA Questions Response

FieldTypeDescription
dataKbaQuestionsSuccess message
errors[SendKbaAnswersError]List of errors

KbaQuestions

KBA Questions

FieldTypeDescription
questions[KbaQuestion]KBA Questions
KbaQuestion

KBA Question

FieldTypeDescription
idString!KBA Question ID
questionString!KBA Question
options[kbaQuestionOption]KBA Questions answer options
kbaQuestionOption

KBA Questions answer option

FieldTypeDescription
idString!KBA Questions option ID
textString!KBA Questions option text

SendKbaAnswersError

FieldTypeDescription
messageStringKBA requesting questions error message

Error Types

The response may include the following error types:

SendKbaAnswersError

FieldTypeDescription
messageStringKBA requesting questions error message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference