Security Q&A
The Security Q&A APIs allows users to fetch the list of security Questions, create, get, update, and Reset Security Q&A.
1. List Of Security Questions¶
Description
The securityQuestions endpoint is used to fetch the list of security questions of the application.
Request
Endpoint
/ui/v1/securityQuestions/{userId}
Note
ReplaceuserId with the respective user id. User id is mandatory, is numeric only, and minimum length is 1.
Given a userId the Request URL looks as below
/ui/v1/securityQuestions/173
Method
GET
Header
Content-Type: application/json
Response
[
{
"id": 1,
"groupNumber": "100",
"securityQuestion": "What was your childhood nickname?",
"message": null
},
{
"id": 2,
"groupNumber": "100",
"securityQuestion": "In what city did you meet your spouse/significant other?",
"message": null
},
{
"id": 3,
"groupNumber": "100",
"securityQuestion": "What is the name of your favorite childhood friend?",
"message": null
},
{
"id": 4,
"groupNumber": "100",
"securityQuestion": "What street did you live on in third grade?",
"message": null
},
{
"id": 5,
"groupNumber": "100",
"securityQuestion": "What is your oldest sibling's birthday month and year? (e.g., January 1900)",
"message": null
},
{
"id": 6,
"groupNumber": "100",
"securityQuestion": "What is the middle name of your oldest child?",
"message": null
},
{
"id": 7,
"groupNumber": "100",
"securityQuestion": "In what city or town was your first job?",
"message": null
},
{
"id": 8,
"groupNumber": "200",
"securityQuestion": "What is your oldest sibling's middle name?",
"message": null
},
{
"id": 9,
"groupNumber": "200",
"securityQuestion": "What school did you attend for sixth grade?",
"message": null
},
{
"id": 10,
"groupNumber": "200",
"securityQuestion": "What was your childhood phone number including area code? (e.g., 000-000-0000)",
"message": null
},
{
"id": 11,
"groupNumber": "200",
"securityQuestion": "What is your oldest cousin's first and last name?",
"message": null
},
{
"id": 12,
"groupNumber": "200",
"securityQuestion": "What was the name of your first stuffed animal?",
"message": null
},
{
"id": 13,
"groupNumber": "200",
"securityQuestion": "In what city or town did your mother and father meet?",
"message": null
},
{
"id": 14,
"groupNumber": "200",
"securityQuestion": "What is the name of the place your wedding reception was held?",
"message": null
},
{
"id": 15,
"groupNumber": "300",
"securityQuestion": "Where were you when you had your first kiss?",
"message": null
},
{
"id": 16,
"groupNumber": "300",
"securityQuestion": "What is the first name of the boy or girl that you first kissed?",
"message": null
},
{
"id": 17,
"groupNumber": "300",
"securityQuestion": "What was the last name of your third grade teacher?",
"message": null
},
{
"id": 18,
"groupNumber": "300",
"securityQuestion": "In what city does your nearest sibling live?",
"message": null
},
{
"id": 19,
"groupNumber": "300",
"securityQuestion": "What is your oldest brother's birthday month and year? (e.g., January 1900)",
"message": null
},
{
"id": 20,
"groupNumber": "300",
"securityQuestion": "What is your maternal grandmother's maiden name?",
"message": null
},
{
"id": 21,
"groupNumber": "300",
"securityQuestion": "What is the name of a college you applied to but didn't attend?",
"message": null
}
]
2. Create User Security Q&A¶
Description
The createUserSecurityQuestionAnswers endpoint is used to create user's security questions and answers with the VELA application.
Request
Endpoint
/ui/v1/createUserSecurityQuestionAnswers
Method
POST
Header
Content-Type: application/json
Attributes
| ELEMENT | DESCRIPTION | FORMAT |
|---|---|---|
| Security Questions | Required Three security questions to be chosen by the user |
|
| Security Answers | Required Three security answers to be entered by the user |
• Min. no. of characters - 2 • Max. no. of characters - 50 |
Request Body
[{
"id": "",
"userId": 513,
"securityQuestionId": 1,
"answer": "11"
}, {
"id": "",
"userId": 513,
"securityQuestionId": 8,
"answer": "12"
}, {
"id": "",
"userId": 513,
"securityQuestionId": 15,
"answer": "13"
}]
Response
{
"records": null,
"message": {
"code": "113",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "Your registration has been successfully completed. Please log in with your new credentials. A welcome <strong>text message</strong> and/or an <strong>email</strong> have been sent to the mobile number and email address respectively on record. Please check your Spam, Junk, or Bulk folder if you do not see it."
}
}
3. Get User Security Q&A¶
Description
The getUserSecurityQuestionAnswers endpoint is used to get user's security questions and answers that are associated with the VELA application.
Request
Endpoint
/ui/v1/getUserSecurityQuestionAnswers
Method
POST
Header
Content-Type: application/json
Request Body
{
"userId":"195"
}
Response
{
"records": [
{
"id": 262,
"userId": 195,
"securityQuestionId": 1,
"answer": "11",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
},
{
"id": 263,
"userId": 195,
"securityQuestionId": 8,
"answer": "12",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
},
{
"id": 264,
"userId": 195,
"securityQuestionId": 15,
"answer": "13",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
}
],
"message": null
}
4. Update User Security Q&A¶
Description
The updateUserSecurityQuestionAnswers endpoint is used to update user's security questions and answers that are associated with the VELA application.
Request
Endpoint
/ui/v1/updateUserSecurityQuestionAnswers
Method
POST
Header
Content-Type: application/json
Request Body
[{
"id": 262,
"userId": 195,
"securityQuestionId": 1,
"answer": "11",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
},
{
"id": 263,
"userId": 195,
"securityQuestionId": 8,
"answer": "12",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
},
{
"id": 264,
"userId": 195,
"securityQuestionId": 15,
"answer": "13",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
}
]
Response
[{
"id": 262,
"userId": 195,
"securityQuestionId": 1,
"answer": "11",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": {
"code": "64",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Security Questions and Answers have been updated successfully."
},
"email": null,
"mobile": null
},
{
"id": 263,
"userId": 195,
"securityQuestionId": 8,
"answer": "12",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
},
{
"id": 264,
"userId": 195,
"securityQuestionId": 15,
"answer": "13",
"createdDateTime": 1563308528000,
"lastUpdatedDateTime": null,
"securityQuestion": null,
"message": null,
"email": null,
"mobile": null
}
]
5. Reset Security Q&A¶
Description
The resetUserSecurityQuestionAnswers endpoint is used to reset user's security questions and answers with the VELA application.
Request
Endpoint
/ui/v1/resetUserSecurityQuestionAnswers
Method
POST
Header
Content-Type: application/json
Request Body
{
"id": 9,
"userName": "commonuser1"
}
Response
{
"country": "USA",
"addressLine1": "12000 Findley Road",
"addressLine2": "Suite 350",
"addressLine3": null,
"city": "Johns Creek",
"state": "GA",
"zipCode": "30097",
"id": 9,
"userName": "commonuser1",
"password": "$2a$11$UbwQ3r1oqfE13TtSqFSVX.hMqbX5QBjsmue934ng8rpOvDL4J0zMq",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "common",
"lastName": "user1",
"phone": "4047549984",
"mobile": "",
"fax": "",
"jobTitle": null,
"department": null,
"roles": [{
"id": 18,
"roleType": {
"value": "Customer User",
"name": "CUSTOMER_USER"
},
"checked": true
}],
"userChannelMap": [{
"id": 9,
"channel": {
"id": 45,
"channelName": "Cybersource",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1555006414000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"paymentMethods": [{
"id": 380,
"paymentMethodType": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635800000,
"lastUpdatedDateTime": null,
"position": 109
},
{
"id": 367,
"paymentMethodType": {
"value": "3D Secure",
"name": "THREE_D_SECURE"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VERIFIED by VISA",
"name": "VERIFIED_BY_VISA"
},
"cardId": 127,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635799000,
"lastUpdatedDateTime": null,
"position": 96
},
{
"id": 373,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635800000,
"lastUpdatedDateTime": null,
"position": 102
},
{
"id": 341,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635797000,
"lastUpdatedDateTime": null,
"position": 70
},
{
"id": 381,
"paymentMethodType": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635801000,
"lastUpdatedDateTime": null,
"position": 110
},
{
"id": 467,
"paymentMethodType": {
"value": "PayPal",
"name": "PAYPAL"
},
"paymentGateway": {
"value": "PayPal",
"name": "PAYPAL"
},
"cardBrand": {
"value": "PayPal",
"name": "PAYPAL"
},
"cardId": null,
"createdUserId": 195,
"lastModifiedUserId": null,
"createdDateTime": 1571345178000,
"lastUpdatedDateTime": null,
"position": 129
}
],
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null
}
}],
"oldEmail": "commonuser1@datumsoftware.com",
"email": "commonuser@datumsoftware.com",
"locale": "en_US",
"lastLoginDateTime": 1567813683000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 1,
"lastModifiedUserId": 195,
"firstLoginDateTime": 1481507029000,
"maximumAllowedLoginDays": 99999,
"organizationName": "Datum Software, Inc. 111",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"value": "Not Enrolled",
"name": "NOT_ENROLLED"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"value": "None",
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1569876771000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 3,
"createdDateTime": 1481507029000,
"forceChangeSecurityQuestionsInd": true,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"customerId": 4,
"acceptTermsOfUseAgreementInd": false,
"acceptPrivacyPolicyAgreementInd": false,
"namePrefix": null,
"nameSuffix": null,
"middleInitial": null,
"paymentAction": {
"value": "Sale",
"name": "SALE"
},
"mobilePhoneCarrierType": {
"emailDomain": "",
"value": "Select",
"countryCode": "UNKNOWN",
"name": "UNKNOWN"
},
"transactionCategory": {
"value": "Card Not Present",
"name": "CARD_NOT_PRESENT"
},
"message": {
"code": "65",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The User <strong>commonuser1</strong>'s Security Questions and Answers have been reset to blank successfully."
},
"address": null,
"fullName": null,
"minimumPasswordLength": null,
"minimumLowercaseAlphabets": null,
"minimumUppercaseAlphabets": null,
"minimumNumerics": null,
"minimumSpecialCharacters": null,
"sessionId": null,
"uiType": null,
"customerName": null,
"customerNumber": null,
"geoLocation": null,
"currentPassword": null,
"reEnterPassword": null,
"reEnterEmail": null,
"merchantName": null,
"language": null,
"merchantCode": null,
"passwordAlreadyExists": false,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": null
}
Updated As Of Version 2.4.0.0