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

Mandatory

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

DecisionFlag

integer

Mandatory

Flag for confirming if Used for Forget Password or Forget UserID Valid Values:'1' = Forgot Password, '2' = ForgotUserID Format:X Example:2

AddressLine1

string

Conditional

Card holder's Address Line 1 Valid Values:A-Z, 0-9 Example:123 HWY Condition:Address Line 1 of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System

Allowable Values:

40

AddressLine2

string

Conditional

Card holder's Address Line 2 Valid Values:A-Z, 0-9 Example:123 HWY Condition:Address Line 2 of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System

Allowable Values:

40

EmailID

string

Conditional

Card holder's Email ID Valid Values: 0-9, A-Z Format:XX@XX.Com Example:ABC@gmail.com Condition:EmailID of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System and is Set as 'Mandatory' in System

Allowable Values:

100

HomePhoneNumber

string

Conditional

Card holder Home Phone number Valid Values:0-9 Format:XXXXXXXXXX Example:7895463214 Condition:Home Phone number of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System.

Allowable Values:

19

WorkPhoneNumber

string

Conditional

Card holder Work phone number Valid Values:0-9 Format:XXXXXXXXXXX Example:5678909876 Condition:Work Phone number of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System

Allowable Values:

19

PostalCode

string

Conditional

Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Condition:Postal Code of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System

Allowable Values:

10

DateofBirth

datetime

Conditional

Card Holder's Date of Birth Valid Values: 0-9 Format: MM/dd/yyyy Example: 02/01/2020 Condition:Date of Birth of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters in System

SocialSecurityNumber

string

Conditional

Social Security Number of the AccountHolder Format:AAAGGSSSS Example::078051120 Condition:SocialSecurityNumber of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or "Forget Password Validation Parameters in System

Allowable Values:

9

CardExpirationDate

string

Conditional

ate when card is be expired. Valid Values: 0-9 Format: MMYYYY Example: 012020 Condition:Card Expiration Date of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters' in system

Allowable Values:

6

SSNLast4Digits

string

Conditional

Card holder's last four digit of SSN Valid Values:1120 Format:XXXX Example:1120 Condition:Last 4 digits of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or'Forget Password Validation Parameters' in system

Allowable Values:

4

YearofBirth

integer

Conditional

Year of Birth of the Account holder Valid Values:0-9 Format:XXXX Example:1920 Condition:BirthYear of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' or 'Forget Password Validation Parameters' in system

ListSecurityQuestionsAnswers

array

Conditional

ListSecurityQuestionsAnswers

CurrentPassword

string

Conditional

Current Password Set for the Account Holder's Selfservice Login Condition:Current Selfservice Password of the Account Holder, Mandatoy if Set as option in one of the Validation Field in 'Forgert User ID Validation' Parameters in System

Allowable Values:

30

DecisionFlag

integer

Will Return The codes for Either UserID or Password Valid Values: '1' = For Password, '2' = For UserID If Returned for Password, will mean will Prompt on Panel to change the Password If Returned for User ID, will mean the User will be Sent on Account Holders Email or SMS depending on what is Set on Product, or will be Displayed on the Panel Condition: For this API this Tag can be used as one of the Input Paramter for Fecthing the Details