Get User ID Password Parameters
Action: POST
Endpoint: /api/CoreCredit/UserManagement/GetUserIDPasswordParameters
Use this API to retrieve the validation parameters set for Forgot User ID and Forgot Password, defined in the program for an institution.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required. Allowable Values: 19 |
AccountNumber string Conditional |
Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required. Allowable Values: 19 |
SSUserID string Conditional |
Self Service User ID of the Account Holder Condition: For this API this Tag can be used as one of the Input Paramter for Fecthing the Details Allowable Values: 20 |
DecisionFlag integer Mandatory |
Flag for confirming if Used for Forget Password or Forget UserID Valid Values:'1' = Forgot Password, '2' = ForgotUserID and '5' = Reset Securirty Question Format:X Example:2 |
AdminNumber int64 Conditional |
Admin number. Valid Values: 0-9 Example: 12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required. |
InstitutionID string Optional |
Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
ProductID string Optional |
Product ID Valid Values:0-9 Format:XXXX Example:Product ID of Card. |
Sample request body
{ "Source": "Web", "IPAddress": null, "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CardNumber": null, "AdminNumber": null, "AccountNumber": "8000000000000219", "SSUserID": null, "DecisionFlag": 2, "InstitutionID": null, "ProductID": null }
Response fields details
Fields | Description |
---|---|
SecurityQuestionsList array |
List of Security Questions IDs and Descriptions as set in the System on the Product |
Validation1 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 1st Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
Validation2 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 2nd Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
Validation3 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 3rd Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
Validation4 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 4th Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
Validation5 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 5th Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
Validation6 integer |
Depending on the Decision Flag, SelfService Forgot UserID or Forgot UserID Validation Parameter, must return the Parameter Name set on 6th Validation Field in System Valid Values: 18 - Birth Year 11 - Card Expiration Date 13 - Current Password(only for forgot userID) 27 - Card Number(only for forgot password) 17 - CVC2 3 - E Mail One 2 - Full Address 4 - Home Phone 16 - Last 4 Digits of Primary ID 26 - OTP 6 - Postal Code 25 - Security Questions 5 - Work Phone Format:XX Example: 16 |
MinPasswordLength integer |
Minimum Password Length Required As per password Policy Valid Values:- 0-9 Format:XX Example:5 |
MaxPasswordLength integer |
Maximum Password Length allowed As per password Policy Valid Values:- 0-9 Format:XX Example:5 |
NoOfUppCaseReq integer |
Number of Upper Case letters Required in a Password As per the password Policy Valid Values:- 0-9 Format:XX Example:5 |
NoOfLowCaseReq integer |
Number of Lower Case letters Required in a Password As per the password Policy Valid Values:- 0-9 Format:XX Example:5 |
NoOfDigitReq integer |
Number of Digits Required in a Password As per the password Policy Valid Values:- 0-9 Format:XX Example:5 |
NoOfSymbolReq integer |
Number of Symbols Required in a Password As per the password Policy Valid Values:- 0-9 Format:XX Example:5 |
MinAlphaReq integer |
Number of Alphabets Required in a Password As per the password Policy Valid Values:- 0-9 Format:XX Example:5 |
PasswordHistory integer |
Upto what Number of Last Passwords are not allowed to Repeat again in an Upcoming Password as per the password policy Valid Values:- 0-9 Format:XX Example:5 |
CompSameConsecutive integer |
If Setting Same Consecutive Passwords is allowed or not as per the password policy Valid Values: 0 = No, 1 = Yes |
PartialUserName integer |
If Partial UserName is allowed or not as per the password policy Valid Values: 0 = No, 1 = Yes |
MobileCarrier string |
Carrier of Mobile Phone number Valid Values:a-z,0-9 Format:XXXXXX Example:ATt Allowable Values: 25 |
MobilePhoneNumber string |
Mobile Phone Number Valid Values:0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 15 |
EmailID string |
Card holder's Email ID Valid Values: 0-9, A-Z Format:XX @XX.Com Example:ABC @gmail.com Allowable Values: 300 |
NumberOfQuestionAsked integer |
Number of Security Questions can be Asked Valid Values: 0-9 Format:X Example:4 |
ValidationMethod integer |
Defines the Validation Method Set in System for UserID or Password on the Product under which the Account is Created Must Return the Value Depending on the Decision Flag either for UserID or For Password Valid Values: '0' = System Defined, '1' = User Defined If User Defined then whatever Set in Validation Field will be Mandatory for Validating Userid or Password If System Defined then doesnt Matter what is set in Validation Field, only Security Questions and Answers will be mandatory for Validating UserID or Password Format: X Example: 1 |
OTPMode integer |
The Mode of OTP Email ID or Mobile Number or Both Must return the OTP mode only if the Validation Method is set as OTP Valid Values: '1' = Mobile Number, '2' = Email ID and '3' = Both Format:X Example:1 |
InvalidOTPAttempts integer |
The No. of Invalid OTP attempts Allowed Valid Values:- 0-9 Format:XX Example:5 |
OTPActiveDuration integer |
Active duration of OTP in Minutes Valid Values:- 0-9 Format:XX Example:5 |
NumberOfAnswerRequired integer |
Number of Security Answers required Valid Values:- 0-9 Format:XX Example:5 |
CardNumber string |
Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Allowable Values: 16 |
AccountNumber string |
Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
AdminNumber int64 |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:1234 |
Sample response body
{ "Message": "Return Successfully", "Status": false, "ErrorCode": "ERR01093", "ResponseData": { "SecurityQuestionsList": [ { "SecurityQuestionID": 1216, "SecurityQuestionDescription": "Which city were you born in?" }, { "SecurityQuestionID": 1217, "SecurityQuestionDescription": "What is the name of your best friend?" }, { "SecurityQuestionID": 1218, "SecurityQuestionDescription": "What is the name of your pet?" }, { "SecurityQuestionID": 1219, "SecurityQuestionDescription": "What is your Mothers Maiden Name ?" }, { "SecurityQuestionID": 1220, "SecurityQuestionDescription": "What was the name of your favorite childhood pet?" }, { "SecurityQuestionID": 1221, "SecurityQuestionDescription": "What was the make of your first car?" }, { "SecurityQuestionID": 1222, "SecurityQuestionDescription": "What was the first name of your closest childhood friend?" }, { "SecurityQuestionID": 1223, "SecurityQuestionDescription": "What is the name of the elementary school you attended?" } ], "Validation1": 16, "Validation2": 25, "Validation3": null, "Validation4": null, "Validation5": null, "Validation6": null, "MinPasswordLength": 8, "MaxPasswordLength": 32, "NoOfUppCaseReq": 1, "NoOfLowCaseReq": 1, "NoOfDigitReq": 1, "NoOfSymbolReq": 1, "MinAlphaReq": 2, "PasswordHistory": 5, "CompSameConsecutive": 0, "PartialUserName": 1, "MobileCarrier": null, "MobilePhoneNumber": "7896541236", "EmailID": "dd3232srwe4343@sds.com", "NumberOfQuestionAsked": 3, "ValidationMethod": 1, "OTPMode": null, "InvalidOTPAttempts": null, "OTPActiveDuration": null, "NumberOfAnswerRequired": 2, "CardNumber": "8888010000000025", "AccountNumber": "8000000000000029", "AdminNumber": 129363, "userid": null } }