Category links

API Links

Self-Service User Management

The CoreCard system provides various APIs to manage the self-service portal login. These have various functionalities, such as self-service user registration, card activation, PIN reset, linking or delinking a card account to a self-service portal login ID, and updating answers to security questions. 

Delink Account

Action: POST

Endpoint: /api/CoreCredit/UserManagement/DeLinkAccount

POST /api/CoreCredit/UserManagement/DeLinkAccount

Use this API to delink the account against a self-service user ID by using the account number.

Note

The main account which was initially used to register the user and for creating the self-service user ID is not delinked using this API even if that account is in closed status. The Main account is always linked with the self-service user ID.

Request fields detail
Fields Description

Source

string

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

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

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

AccountNumber

string

Mandatory

Account number of cardholder that is to be De-linked. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

SSUserID

string

Mandatory

The Self service user ID of Account Holder from which the mentioned account number is to de-linked. Valid Values: A-Z,0-9 Format: XXXXXXXXXXXXX Example: MyUserID

Allowable Values:

30
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "8888010000000231",
  "AccountNumber": "8000000000000227"
}
Response fields detail
Fields Description

ErrorFound

string

Checks if error found or not.

Allowable Values:

20

ErrorNumber

string

Specifc error number.

Allowable Values:

20

ErrorMessage

string

The error message against error number Valid Values: a-z Format: abc xyz

Allowable Values:

20

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body 

{
  "application/json": {
    "Message": "Return Successfully.",
    "Status": true,
    "ErrorCode": "ERR01093",
    "ResponseData": {}
  }
}

Get Link Accounts

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetLinkAccounts

POST /api/CoreCredit/UserManagement/GetLinkAccounts

Use this API to retrieve the details of all linked accounts with summary details by using the cardholder's self-service user ID.

Request fields detail
Fields Description

Source

string

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

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

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

SSUserID

string

Mandatory

Self Service User ID of the Account Holder Valid Values: a-z,0-9 Format: XXXXXXXXXX Example: Newuser123

Allowable Values:

30
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "account1"
}
Response fields detail
Fields Description

AccountDetails

array

Account Details

ResponseID

integer

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9, a-z Format:xxx Example:200

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "AccountDetails": [
        {
          "AccountNumber": "8000000000000011",
          "AccountID": 167493,
          "AdminNumber": 129362,
          "UserID": "account1",
          "LinkedCardBy": "bcssapi",
          "LinkedCardDate": "05/11/2020 19:05:27",
          "LinkCardStatus": "1",
          "ProductID": 3399,
          "SubProductType": "ABC Product",
          "AccountStatus": "Active",
          "OpenToBuy": "6245"
        }
      ],
      "ResponseID": 56794586
    }
  }
}

Reset Pin Attempts

Action: POST

Endpoint: /api/CoreCredit/UserManagement/ResetPinAttempts

POST /api/CoreCredit/UserManagement/ResetPinAttempts

Use this API to reset an invalid PIN attempt counter. The invalid PIN attempt counter increases when a cardholder attempts an authorization transaction or other activity with an incorrect PIN.

Note

This API resets the value of an invalid PIN attempt counter only when there is value available to reset. In case there is no value of invalid PIN attempts are available then CoreCARD returns the error.

Request fields detail
Fields Description

Source

string

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

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

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:XXXXXXXXXXXX Example:123654789654 Condition:At least one of AdminNumber/CardNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/CardNumber is required.

ResetAction

integer

Mandatory

Reset Action to perform. Valid Values: 0- Pin Attempts,1-Card Activation Invalid Attempts, 2- Authorization PIN Attempts Example:0

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "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": 167257354,
  "ResetAction": 0
}
Response fields detail
Fields Description

NoOfPinAttempts

integer

Number of Pin Attempts to be made. Valid Values:0-9 Example : 2

Sample response body 

{
  "application/json": {
    "Message": "PIN Attempts counter has been reset successfully.",
    "Status": true,
    "ErrorCode": "ERR01036",
    "ResponseData": {
      "NoOfPinAttempts": 1
    }
  }
}

Reset Card PIN

Action: POST

Endpoint: /api/CoreCredit/UserManagement/ResetCardPIN

POST /api/CoreCredit/UserManagement/ResetCardPIN

This API is used to Reset the Card pin.

Request fields detail
Fields Description

Source

string

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

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

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXXXXX Example:7488888 Condition: At least one of CardNumber/AdminNumber is required.

CardNumber

string

Conditional

Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition: At least one of CardNumber/AdminNumber is required.

Allowable Values:

19
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 167257354,
  "CardNumber": null
}
Response fields detail
Fields Description

PIN

string

Pin of the card.

Allowable Values:

4

Sample response body 

{
  "application/json": {
    "Message": "Pin has been reset.",
    "Status": true,
    "ErrorCode": "ERR04078",
    "ResponseData": {
      "PIN": "XXXX"
    }
  }
}

Reset Virtual Card Limit

Action: POST

Endpoint: /api/CoreCredit/UserManagement/ResetVirtualCardLimit

POST /api/CoreCredit/UserManagement/ResetVirtualCardLimit

Use this API to reset the card limit of a virtual card or reset the number of transactions allowed on a virtual card.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Atleast one of AdminNumber/CardNumber is required

CardNumber

string

Conditional

Card Number of account holder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632 Condition: Atleast one of AdminNumber/ CardNumber is required

Allowable Values:

19

ResetLimitFlag

integer

Conditional

Flag to reset card limit Valid Values: Send 1 in this flag if user want to update card's actual limit Example:1 Condition: ResetLimitFlag is mandatory if ResetTxnFlag is null or blank.

CardLimit

decimal

Conditional

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00 Condition : If ResetLimitFlag is true then CardLimit field is mandatory.

ResetTxnFlag

integer

Conditional

Flag to reset card's number of allowed transactions. Valid Values: Send 1 in this flag if user want to update card's number of allowed transactions. Example:true Condition:ResetTxnFlag is mandatory if ResetLimitFlag is null or blank.

NumberAllowedTxn

integer

Conditional

NumberAllowedTxn of virtual card will set to this field value. Condition:If ResetTxnFlag is true then NumberAllowedTxn field is mandatory.

VirtualCardLimitMethod

integer

Optional

Method on which Virtual Card limit is applied e.g. Account / Card. Valid Values: 0 = It means VirtualCardLimitMethod is Account (i.e Virtual Card uses Credit limit of Account) 1 = It means VirtualCardLimitMethod is Card (i.e Virtual Card uses Credit limit of its)

Source

string

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

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

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

AdminNumber

int64

Mandatory

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

ResetLimitFlag

integer

Conditional

Flag to reset card limit Valid Values: Send 1 in this flag if user want to update card's actual limit Example:1 Condition: ResetLimitFlag is mandatory if ResetTxnFlag is null or blank.

CardLimit

decimal

Conditional

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00 Condition : If ResetLimitFlag is true then CardLimit field is mandatory.

ResetTxnFlag

integer

Conditional

Flag to reset card's number of allowed transactions. Valid Values: Send 1 in this flag if user want to update card's number of allowed transactions. Example:true Condition:ResetTxnFlag is mandatory if ResetLimitFlag is null or blank.

NumberAllowedTxn

integer

Conditional

NumberAllowedTxn of virtual card will set to this field value. Condition:If ResetTxnFlag is true then NumberAllowedTxn field is mandatory.

VirtualCardLimitMethod

integer

Optional

Method on which Virtual Card limit is applied e.g. Account / Card. Valid Values: 0 = It means VirtualCardLimitMethod is Account (i.e Virtual Card uses Credit limit of Account) 1 = It means VirtualCardLimitMethod is Card (i.e Virtual Card uses Credit limit of its)

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 167257354,
  "ResetLimitFlag": 1,
  "CardLimit": 5000.0,
  "ResetTxnFlag": null,
  "NumberAllowedTxn": null,
  "VirtualCardLimitMethod": null
}
Response fields detail
Fields Description

CardLimit

decimal

Card Limit of virtual card will set to this field value. Valid Values: Format:XXX.XX Example:500.00

NumberAllowedTxn

integer

NumberAllowedTxn of virtual card will set to this field value. Valid Values:0-9 Format:XX Example:10

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking

Allowable Values:

15

CardLimit

decimal

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00

NumberAllowedTxn

integer

NumberAllowedTxn of virtual card will set to this field value. Valid Values:0-9 Format:XX Example:10

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking

Allowable Values:

15

Sample response body 

{
  "application/json": {
    "Message": "Updated Successfully.",
    "Status": true,
    "ErrorCode": "ERR01045",
    "ResponseData": {
      "CardLimit": 5000.0,
      "NumberAllowedTxn": 10,
      "ResponseID": "47785665"
    }
  }
}

Card Activation Request

Action: POST

Endpoint: /api/CoreCredit/UserManagement/CardActivationRequest

POST /api/CoreCredit/UserManagement/CardActivationRequest

Use CoreCARD to configure card activation parameters per card program that are required for the cardholder to validate their identity. This API can use the established parameters to validate and activate a card.

Request fields detail
Fields Description

Source

string

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

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

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 is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 Condition:At least one of CardNumber/AdminNumber is required.

CardType

integer

Mandatory

Type of the card as Visa, Master etc. Valid Values: 0 - MASTER 1 - DISCOVER 2 - STAR 3 - OTHER 4 - VISA Example: 4 - VISA

FirstName

string

Conditional

Card Holder's First Name. Valid Values:A-Z Example:John Condition : Required when Card Activation Validation Parameters on Product include First Name.

Allowable Values:

50

MiddleName

string

Conditional

Card Holder's Middle Name. Valid Values: A-Z Example: LEE Condition : Required when Card Activation Validation Parameters on Product include Middle Name.

Allowable Values:

50

LastName

string

Conditional

Card holder's Last Name. Valid Values: A-Z Example: Smith Condition : Required when Card Activation Validation Parameters on Product include Last Name.

Allowable Values:

50

AddressLine1

string

Conditional

Card Holder's Address Line 1. Valid Values:A-Z, 0-9 Example:123 HWY Condition : Required when Card Activation Validation Parameters on Product include AddressLine1.

Allowable Values:

50

AddressLine2

string

Conditional

Card Holder's Address Line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Condition : Required when Card Activation Validation Parameters on Product include AddressLine2.

Allowable Values:

50

EmailID

string

Conditional

Card Holder's Email Address. Valid Values: abc@cc.com Format: xxx@xx.com Example: abc@cc.com Condition : Required when Card Activation Validation Parameters on Product include EmailID.

Allowable Values:

100

HomePhoneNumber

string

Conditional

Card Holder's Home Phone number. Valid Values:0-9 Example:7895463214 Condition : Required when Card Activation Validation Parameters on Product include Home Phone Number.

Allowable Values:

20

WorkPhoneNumber

string

Conditional

Card Holder's Work Phone number. Valid Values:0-9 Example:5678909876 Condition : Required when Card Activation Validation Parameters on Product include Work Phone Number.

Allowable Values:

20

PostalCode

string

Conditional

Postal Code of the Card Holder's Address. Valid Values:0-9 Example:46206 Condition : Required when Card Activation Validation Parameters on Product include Postal Code.

Allowable Values:

10

DateOfBirth

datetime

Conditional

Card Holder's Date of Birth. Valid Values:01/12/1990 Format: MM/dd/yyyy Example:07/25/1991 Condition : Required when Card Activation Validation Parameters on Product include DateOfBirth.

LanguageIndicator

string

Optional

Language Indicator. Valid Values:en,es Example:es

Allowable Values:

5

SocialSecurityNumber

string

Conditional

Social Security Number. Valid Values:0-9 Example: 678051120 Condition : Required when Card Activation Validation Parameters on Product include SocialSecurityNumber.

Allowable Values:

9

CardExpirationDate

string

Conditional

Card Expiration Date of requested card. Valid Values:0-9 Format:MMYYYY Example: 012020 Condition : Required when Card Activation Validation Parameters on Product include CardExpirationDate.

Allowable Values:

8

SSNLast4Digits

string

Conditional

Card Holder's last four digit of SSN. Valid Values:0-9 Example:1120 Condition : Required when Card Activation Validation Parameters on Product include SSNLast4Digits.

Allowable Values:

4

ActivationCode

string

Conditional

Code which is provided at the time of Account Creation/Registration should be pass as a user validation for card. Valid Values:0-9 Example:1120 Condition : Required when Card Activation Validation Parameters include Activation Code.

Allowable Values:

50
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "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": 100989,
  "CardType": 0,
  "FirstName": null,
  "MiddleName": null,
  "LastName": null,
  "AddressLine1": null,
  "AddressLine2": null,
  "EmailID": null,
  "HomePhoneNumber": null,
  "WorkPhoneNumber": null,
  "PostalCode": "43633615",
  "DateOfBirth": "03/31/1990 00:00:00",
  "LanguageIndicator": null,
  "SocialSecurityNumber": null,
  "CardExpirationDate": null,
  "SSNLast4Digits": null,
  "ActivationCode": null
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Card activated successfully.",
    "Status": true,
    "ErrorCode": "ERR01008",
    "ResponseData": null
  }
}

Get Card Activation Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetCardActivationParameters

POST /api/CoreCredit/UserManagement/GetCardActivationParameters

Use this API to retrieve the card activation validation parameters defined on the program for an institution within CoreCARD's system. Further, these parameter values can be used to validate and activate a card.

Request fields detail
Fields Description

Source

string

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

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

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

InstitutionID

integer

Mandatory

Unique identification number for Institution. Valid Values:0-9 Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Optional

ID assigned to a Program. Valid Values:0-9 Example:Fixed value provided by CoreCard.

CardNumber

string

Conditional

Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition: At least one of CardNumber/AdminNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXXXXX Example:7488888 Condition: At least one of CardNumber/AdminNumber is required.

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InstitutionID": null,
  "ProductID": null,
  "CardNumber": null,
  "AdminNumber": 100989
}
Response fields detail
Fields Description

Validation1

string

Validation 1 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation2

string

Validation 2 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation3

string

Validation 3 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation4

string

Validation 4 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation5

string

Validation 5 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation6

string

Validation 6 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "Validation1": "7",
      "Validation2": "11",
      "Validation3": "0",
      "Validation4": "0",
      "Validation5": "0",
      "Validation6": "0"
    }
  }
}

Link Multiple Accounts

Action: POST

Endpoint: /api/CoreCredit/UserManagement/LinkMultipleAccounts

POST /api/CoreCredit/UserManagement/LinkMultipleAccounts

Use this API to link another account number to the self-service user.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

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

SSUserID

string

Mandatory

The Self service user ID of Account Holder to which mentioned Account is to be linked Valid Values: A-Z , 0-9 Format: XXXXXXXXXXXXX Example: MyUserID

Allowable Values:

32

AccountNumber

string

Mandatory

Account number of cardholder to be linked to the mentioned UserID. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

Source

string

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

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

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

SSUserID

string

Mandatory

The Self service user ID of Account Holder to which mentioned Account is to be linked Valid Values: A-Z , 0-9 Format: XXXXXXXXXXXXX Example: MyUserID

Allowable Values:

32

AccountNumber

string

Mandatory

Account number of cardholder to be linked to the mentioned UserID. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19
Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "MyUserID",
  "AccountNumber": "8000000000000227"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Return Successfully.",
    "Status": true,
    "ErrorCode": "ERR01093",
    "ResponseData": {}
  }
}

Unlock Self-service User

Action: POST

Endpoint: /api/CoreCredit/UserManagement/UnlockSelfServiceUser

POST /api/CoreCredit/UserManagement/UnlockSelfServiceUser

Use this API to unlock a self-service account that is locked out.

Request fields detail
Fields Description

Source

string

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

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

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

SSUserID

string

Mandatory

Self Service User ID of the Account Holder Valid Values: a-z Format: XXXXX Example: Smith.Jones

Allowable Values:

50
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "Account1"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {}
  }
}

Update Security Answers

Action: POST

Endpoint: /api/CoreCredit/UserManagement/UpdateSecurityAns

POST /api/CoreCredit/UserManagement/UpdateSecurityAns

An Institution can configure security questions at the time of registration process. This serves as an extra level of security to validate or authenticate a cardholder in the case of a self-service password reset, changes or other updates to the self-service profile, forgot user ID, and other situations. Use this API to change or update security questions answers set by a cardholder at the time of the registration process.

Request fields detail
Fields Description

Source

string

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

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

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

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

ListSecurityQuestionsAnswers

array

Mandatory

List of Security Questions IDs and Descriptions and Answers as set in the System for the account Holder

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one account identifier is required.

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": null,
  "AccountNumber": "8000000000000235",
  "AccountID": null,
  "ListSecurityQuestionsAnswers": [
    {
      "SecurityQuestionID": 1216,
      "SecurityAnswer": "a"
    },
    {
      "SecurityQuestionID": 1217,
      "SecurityAnswer": "a"
    }
  ]
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Security Answer Registered successfuly",
    "Status": true,
    "ErrorCode": "ERR0000",
    "ResponseData": {}
  }
}

SS Reset Password

Action: POST

Endpoint: /api/CoreCredit/UserManagement/SSResetPassword

POST /api/CoreCredit/UserManagement/SSResetPassword

Purpose of this API is to reset Self Service User password.

Request fields detail
Fields Description
Sample request body 
[
  {
    "in": "header",
    "name": "Authorization",
    "description": "access token",
    "required": true,
    "type": "string",
    "default": "Bearer "
  },
  {
    "in": "body",
    "name": "body",
    "description": "ResetPasswordCoreCreditRequestModel requestModel.",
    "schema": {
      "$ref": "#/definitions/ResetPasswordCoreCreditRequestModel"
    }
  }
]
Response fields detail
Fields Description

Sample response body 

{
  "200": {
    "description": "Success",
    "schema": {
      "$ref": "#/definitions/ResetPasswordCoreCreditResponseModelApiResult"
    },
    "examples": {
      "application/json": {
        "Message": "Processed successfully.",
        "Status": true,
        "ErrorCode": "0",
        "ResponseData": {
          "NewPassword": "123456"
        }
      }
    }
  },
  "Err100001": {
    "description": "[TagName] can not be blank."
  },
  " 0": {
    "description": "Processed successfully."
  },
  "Err00016": {
    "description": "System could not process your request at this time. Please try again."
  }
}

User Registration Request

Action: POST

Endpoint: /api/CoreCredit/UserManagement/UserRegistrationRequest

POST /api/CoreCredit/UserManagement/UserRegistrationRequest

Use this API to register a cardholder in the self-service portal by using user registration validation parameters defined in the card program. Additionally, with this API, a user can set the user ID, password, security questions and answers, and other information.

Request fields detail
Fields Description

Source

string

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

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

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

Allowable Values:

19

NewSSUserID

string

Mandatory

Self Service New User ID to be provided for the Account Holder Valid Values: 0-9 Format: XXXXXX Example: Dani123

Allowable Values:

20

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 one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

50

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 one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

50

Country

string

Conditional

Country name of the Card holder's address For Input Values Refer Appendix Section 5.1 for Country Name Codes Valid Values: a-z Format:XXX Example:US Condition:Country Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

City

string

Conditional

Primary Applicant's City Example: Los Angeles Condition:City Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

40

PostalCode

string

Conditional

Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Condition:Address Postal Code of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

9

State

string

Conditional

State of the card holder address. For Input Values Refer Appendix Section 5.6 for State Name Codes. Valid Values: a-z Format:XXX Example:MO Condition:State Name of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

EmailID

string

Conditional

Card holder's Email ID Valid Values: 0-9, A-Z Format:XX@XX.Com Example:ABC@gmail.com Condition:the Email Address of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

100

NewPassword

string

Mandatory

Password to be Provided for the Account Holder for SelfService Login As per Password Policy Set in System

Allowable Values:

32

ConfirmPassword

string

Mandatory

Verification of the new requested password by the user, Must be exactly same as the New Password

Allowable Values:

32

SSNLast4Digits

string

Conditional

Card holder's last four digit of SSN Valid Values:1120 Format:XXXX Example:1120 Condition:Last 4 digits of the SSN of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

4

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 one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

CardVerificationValue

string

Conditional

CardVerificationValue number mentioned on the Card of the Account Holder Valid Values:0-9 Format: XXX Example: 123 Condition:CardVerificationValue number mentioned on the Card of the Account Holder, Mandatoy if Set as one of the Self Service Registration Parameter in System and is Set as 'Mandatory' in System

Allowable Values:

3

ListSecurityQuestionsAnswers

array

Mandatory

List of Security Questions IDs and Descriptions as set in the System on the Product

AccountNumber

string

Conditional

Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874 Condition: At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 -Account level Memo.

Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "CardNumber": "8888010000000231",
  "AccountNumber": null,
  "AdminNumber": null,
  "NewSSUserID": "Dilesh0231",
  "AddressLine1": null,
  "AddressLine2": null,
  "Country": null,
  "City": null,
  "PostalCode": null,
  "State": null,
  "EmailID": null,
  "NewPassword": "Test123!",
  "ConfirmPassword": "Test123!",
  "SSNLast4Digits": null,
  "DateOfBirth": "07/02/1988 00:00:00",
  "CardVerificationValue": null,
  "ListSecurityQuestionsAnswers": [
    {
      "SecurityQuestionID": 1216,
      "SecurityAnswer": "a"
    }
  ]
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Registration is successful",
    "Status": true,
    "ErrorCode": "ERR0000",
    "ResponseData": {}
  }
}

Validate User ID Password Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/ValidateUserIDPasswordParameters

POST /api/CoreCredit/UserManagement/ValidateUserIDPasswordParameters

Use this API to validate values received for Forgot User ID Validation Parameters or Forgot Password Validation Parameters, as per parameters set up on card program, for cardholder authentication purposes.

Request fields detail
Fields Description

Source

string

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

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

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

Description: 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
Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "CardNumber": "8888010000000025",
  "DecisionFlag": 2,
  "AddressLine1": null,
  "AddressLine2": null,
  "EmailID": null,
  "HomePhoneNumber": null,
  "WorkPhoneNumber": null,
  "PostalCode": null,
  "DateofBirth": null,
  "SocialSecurityNumber": null,
  "CardExpirationDate": null,
  "CurrentPassword": null,
  "SSNLast4Digits": "3725",
  "YearofBirth": null,
  "ListSecurityQuestionsAnswers": null
}
Response fields detail
Fields Description

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

Sample response body 

{
  "application/json": {
    "Message": "Return Successfully",
    "Status": true,
    "ErrorCode": "ERR01093",
    "ResponseData": {
      "DecisionFlag": 2
    }
  }
}

Get User Registration Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetUserRegistrationParameters

POST /api/CoreCredit/UserManagement/GetUserRegistrationParameters

Use this API to retrieve registration validation parameters defined in the program within an institution.

Request fields detail
Fields Description

Source

string

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

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

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:

16

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

AdminNumber

int64

Conditional

Admin number. Valid Values: 0-9 Example: 12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required.

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,
  "AccountNumber": "8000000000000219",
  "AdminNumber": null
}
Response fields detail
Fields Description

SecurityQuestionsList

array

Get or Set listSecurityQuestions

RegistrationParameterList

array

Get or Set listSecurityQuestions

NumberOfQuestionsOffered

integer

Number of Questions Offered Set in System Example: 1,5,10 etc

OTPMode

integer

The Mode of OTP Email ID or Mobile Number or Both Valid Values: '1' = Mobile Number, '2' = Email ID and '3' = Both Format:X Example:1

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

CardNumber

string

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

Allowable Values:

16

AccountNumber

string

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

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

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

Sample response body 

{
  "application/json": {
    "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?"
        }
      ],
      "RegistrationParameterList": [
        {
          "ParameterID": 14,
          "IsRequired": 1
        }
      ],
      "NumberOfQuestionsOffered": 1,
      "OTPMode": null,
      "AdminNumber": 129382,
      "CardNumber": "8888010000000215",
      "AccountNumber": "8000000000000219",
      "MinPasswordLength": 8,
      "MaxPasswordLength": 32,
      "NoOfUppCaseReq": 1,
      "NoOfLowCaseReq": 1,
      "NoOfDigitReq": 1,
      "NoOfSymbolReq": 1,
      "MinAlphaReq": null,
      "CompSameConsecutive": 0,
      "PartialUserName": 1
    }
  }
}

Get User ID Password Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetUserIDPasswordParameters

POST /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 detail
Fields Description

Source

string

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

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

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.

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
}
Response fields detail
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 

{
  "application/json": {
    "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
    }
  }
}

Reset Self-service User ID

Action: POST

Endpoint: /api/CoreCredit/UserManagement/ResetSelfServiceUserID

POST /api/CoreCredit/UserManagement/ResetSelfServiceUserID

This API is used to reset Self-Service User Id for a particular account.

Request fields detail
Fields Description

Source

string

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

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

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

SSUserID

string

Mandatory

Self Service User ID of the Account Holder. Valid Values:a-z, 0-9 Format:XXXXX Example:Smith.Jones

Allowable Values:

100
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "Account11"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": null
  }
}

SSForgotUserID

Action: POST

Endpoint: /api/CoreCredit/UserManagement/SSForgotUserID

POST /api/CoreCredit/UserManagement/SSForgotUserID

This API is used to retrieve the SelfService User ID.

Request fields detail
Fields Description

Source

string

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

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

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:

16
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "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": "8888010000000017"
}
Response fields detail
Fields Description

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9, a-z Format:xxx Example:200

Allowable Values:

15

Sample response body 

{
  "application/json": {
    "Message": "User ID sent to the email address on file",
    "Status": true,
    "ErrorCode": "ERR01991",
    "ResponseData": {
      "ResponseID": "56826609"
    }
  }
}

SSChangePassword

Action: POST

Endpoint: /api/CoreCredit/UserManagement/SSChangePassword

POST /api/CoreCredit/UserManagement/SSChangePassword

This API is used to get the UserID Password Parameters Set in the System.

Request fields detail
Fields Description

Source

string

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

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

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

SSUserID

string

Mandatory

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

OldPassword

string

Old Password Valid Values: 0-9, a-z,special characters Format:XXXXXXXXXX Example:Test123! <required>M</required>

Allowable Values:

32

NewPassword

string

Mandatory

Password to be Provided for the Account Holder for SelfService Login As per Password Policy Set in System

Allowable Values:

32

ConfirmPassword

string

Mandatory

Verification of the new requested password by the user, Must be exactly same as the New Password

Allowable Values:

32
Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "SSUserID": "account1",
  "OldPassword": "abc123@",
  "NewPassword": "acd123!",
  "ConfirmPassword": "acd123!"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Profile updated successfully.",
    "Status": true,
    "ErrorCode": "71",
    "ResponseData": {}
  }
}

CheckUserAvailability

Action: POST

Endpoint: /api/CoreCredit/UserManagement/CheckUserAvailability

POST /api/CoreCredit/UserManagement/CheckUserAvailability

This API is used to check the availability of the SelfService User ID.

Request fields detail
Fields Description

Source

string

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

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

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

UserID

string

Mandatory

Unique ID associated with a user to get access of a portal. Valid Values:0-9 A-Z Format:XXXXXX Example: User123

Allowable Values:

50
Sample request body 
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "UserID": "user123"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "This UserID is available",
    "Status": true,
    "ErrorCode": "ERR01090",
    "ResponseData": null
  }
}