Category links

API Links

Get User Registration Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetUserRegistrationParameters

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

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

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

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

CardNumber

string

Conditional

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

Allowable Values:

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.

InstitutionID

string

Optional

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

ProductID

string

Optional

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

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,
  "InstitutionID": null,
  "ProductID": null
}
Response fields details
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

{
  "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
  }
}