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" }}Open in Apollo Studio Explorer →
Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.
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
| Argument | Type | Description |
|---|---|---|
input | KbaQuestionsInput! | Input containing customer identity and address information for KBA verification |
Input Types
KbaQuestionsInput
Input for KBA question request
Required Fields:
| Field | Type | Description |
|---|---|---|
firstName | String! | customer first name |
lastName | String! | customer last name |
dateOfBirth | String! | dob in yyyy-mm-dd format 1990-04-12 |
ssn | String! | Contact SSN without hyphens |
addressLine1 | String! | Customer address info |
city | String! | Customer address info |
state | String! | Customer address info |
zip | String! | Customer address info |
reqOrgContactId | String! | Requesting organization contact ID |
Optional Fields:
| Field | Type | Description |
|---|---|---|
addressLine2 | String | Customer address info |
zipExtension | String | Customer address info |
Response Type
Returns: KbaQuestionsResponse!
KbaQuestionsResponse
KBA Questions Response
| Field | Type | Description |
|---|---|---|
data | KbaQuestions | Success message |
errors | [SendKbaAnswersError] | List of errors |
KbaQuestions
KBA Questions
| Field | Type | Description |
|---|---|---|
questions | [KbaQuestion] | KBA Questions |
KbaQuestion
KBA Question
| Field | Type | Description |
|---|---|---|
id | String! | KBA Question ID |
question | String! | KBA Question |
options | [kbaQuestionOption] | KBA Questions answer options |
kbaQuestionOption
KBA Questions answer option
| Field | Type | Description |
|---|---|---|
id | String! | KBA Questions option ID |
text | String! | KBA Questions option text |
SendKbaAnswersError
| Field | Type | Description |
|---|---|---|
message | String | KBA requesting questions error message |
Error Types
The response may include the following error types:
SendKbaAnswersError
| Field | Type | Description |
|---|---|---|
message | String | KBA requesting questions error message |
Common Errors
| Error Code | Description | Resolution |
|---|---|---|
VALIDATION_ERROR | Input validation failed | Check required fields and formats |
UNAUTHORIZED | Invalid or expired token | Re-authenticate and retry |
NOT_FOUND | Resource not found | Verify the ID or reference |