Skip to main content

Class AuthenticateRequest

Used to Authenticate a user and receive the token for subsequent requests.


Properties

NAMETYPEDESCRIPTION
RequestIdSystem.stringUnique identifier used to identify the request. Used when associating the request to the response.
RequestDateSystem.DateTimeDateTime request was made. Request timeout is 1 minute.
Credentials JackHenry.Eps.Mobile.CredentialsBase REQUIRED. Generic object representing different security token validation options to authenticate to the EPS system.
DeviceTracking DeviceTracking REQUIRED. The device information used to help identify problems.

CredentialsBase

NAMETYPEDESCRIPTION
PhoneKeySystem.StringREQUIRED. The unique id for the phone. A GUID created by the app vendor at first time use and stored in long term storage on the device which is intended to be unique to the device and application. Limit of 100 characters. Printable characters only.

DeviceTracking

NAMETYPEDESCRIPTION
AppBundleIdSystem.StringREQUIRED. This is the application id used by the different platform stores. ex. eps.mobile.remotedeposit
AppVersionSystem.StringREQUIRED. This is the application version string.
DeviceModelSystem.StringREQUIRED. This is the device's model number.
DeviceSystemNameSystem.StringREQUIRED. This is the device OS the application is running on. ex. ios
DeviceSystemVersionSystem.StringREQUIRED. This is the device's OS version.
VendorSystem.StringREQUIRED. The name of the application vendor. This is not the Financial Institution's name unless they did their own application. This will be generated and provided to the application vendor by EPS during integration.

CustomerCredentials

NAMETYPEDESCRIPTION
CompanySystem.StringREQUIRED. A string value. The users company name in the EPS system. This value is system generated and provided by EPS and correlates to the Financial Institutions RDA MID.
PasswordSystem.StringREQUIRED. A string value. The user's password in the EPS system assigned during user registration or by the user.
UserNameSystem.StringREQUIRED. A string value. The user's direct login name in the EPS system assigned during user registration.

SSOCredentials

NAMETYPEDESCRIPTION
FIIdentifierSystem.StringREQUIRED. A unique string value identifying the Financial Institution's RDA merchant in the EPS system (may be the same as Company, but stored in a different location). By default, this Value is generated and provided by EPS during integration.
HashSystem.StringREQUIRED. A unique string value. Hashed value (either SHA256 or SHA512) used for comparison. The string values must be concatenated in this order: HomeBankingId + Timestamp + FIIdentifier + SharedSecret + SaltValue. Note that the Timestamp used for this hash should be in the format M/d/yyyy h:mm:ss tt. (e.g. 6/17/2019 7:20:40 PM).
HomeBankingIdSystem.StringA string value with a unique identifier for the customer. It is required for all customers boarded with the RDA Web Service and most often corresponds to the customer's unique identifier in the Financial Institution's system. Max length is 50 characters.
SaltValueSystem.StringREQUIRED. A randomly generated string of text by the application vendor, also to be used in the hash calculation to add additional randomness to the hash.
TimestampSystem.DateTimeREQUIRED. Current Date time of the SSO authentication and must be within 10 minutes of the EPS server time. Required to be in the format M/d/yyyy h:mm:ss tt for non-json requests: (e.g., 6/17/2019 7:20:40 PM). Required to be in the format /Date(xxxxxxxxxx-yyy)/ for json requests: (e.g., /Date(1560860654524-300)/)

Examples

{
"__type":"AuthenticateRequest:#JackHenry.Eps.Mobile.RDA",
"Credentials":
"DeviceTracking":
{
"__type":"DeviceTracking:#JackHenry.Eps.Mobile.RDA",
"AppBundleId":"String Content",
"AppVersion":"String Content",
"DeviceSystemName":"String Content",
"DeviceSystemVersion":"String Content",
"DeviceModel":"String Content",
"Vendor":"String Content",
}
}

Methods

Validate(IValidatorContext)

Declaration

public void Validate(IValidatorContext context)

Parameters

TYPENAMEDESCRIPTION
JHA.EPS.SharedService.Common.Validator.IValidatorContextcontext

Exceptions

TYPEDESCRIPTION
JHA.EPS.SharedService.Common.Validator.ValidationResultCredentials must pass authentication
JHA.EPS.SharedService.Common.Validator.ValidationResultToken must be valid
JHA.EPS.SharedService.Common.Validator.ValidationResultCustomer must be enabled
JHA.EPS.SharedService.Common.Validator.ValidationResultCustomer must be authorized
JHA.EPS.SharedService.Common.Validator.ValidationResultTerminal must be enabled
JHA.EPS.SharedService.Common.Validator.ValidationResultMobile Location must exist