SignOnDetail Type

This type corresponds to a single SignOn in the list of SignOn aggregates.

Remarks

SignOnDetail objects are used when listing the supported FI SignOn details returned by the FI OFX server when the GetProfile method is called.

Fields

Aggregate
String

Wrapper for signon information.

Each signon information aggregate contains data (elements and values) associated with the following fields:

MaxPwdLength
MinPwdLength
CaseSensitive
CharType
Spaces
Special
PINChangeFirst
PINChange
AuthTokenFirst
AuthToken
AuthTokenUrl
ClientUIdReq
MFAChallengeReq
MFAChallengeFirst
UserCred1Q
UserCred2Q
Realm

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the component's fields. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the component internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

AuthToken
String

Text label for the Authentication Token.

AuthTokenFirst
Boolean

Indicates whether server requires clients to send the Authentication Token as part of first signon.

If True, then server requires clients to send the AuthToken as part of first signon.

AuthTokenUrl
String

URL where Authentication Token information is provided by the institution operating the OFX server.

CaseSensitive
Boolean

Indicates whether the password is case-sensitive or not.

CharType
SignOnCharTypes

Type of characters the password can contain. The valid values of this string are:


sctAlphaOnly (0)	Password may not contain numeric characters. The server would allow "abbc", but not "1223" or "a122".
sctNumericOnly (1)	Password may not contain alphabetic characters. The server would allow "1223", but no "abbc" or "a122".
sctAlphaOrNumeric (2)	Password may contain alphabetic or numeric characters (or both). The server would allow "abbc", "1223", or "a122".
sctAlphaAndNumeric (3)	Password must contain both alphabetic and numeric characters. The server would allow "a122", but not "abbc" or "1223".
sctUnknown (4)	The server has sent an unrecognized character type. Please refer to the Aggregate to obtain the original response.

ClientUIdReq
Boolean

Indicates whether the Client Unique Identifier is required to be included in the signon.

If this is True, then the ClientUId is required to be set and included in the request.

MaxPwdLength
Integer

Maximum number of characters a SignOn password on this server can have.

MFAChallengeFirst
Boolean

Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.

If True, then server requires clients to request MFA challenge questions (required for MFA) in the first signon request. See RequestChallengeQuestions in FIProfile for more information.

MFAChallengeReq
Boolean

Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.

If True, then server requires multi-factor authentication during each signon. See RequestChallengeQuestions in FIProfile for more information.

MinPwdLength
Integer

Minimum number of characters a SignOn password on this server can have.

PINChange
Boolean

It indicates whether the server accepts any PIN Change Requests at all.

PINChangeFirst
Boolean

Indicates whether server requires clients to change password as part of first signon.

If True, then server requires clients to change OFXPassword as part of first signon. However, if MFAChallengeFirst is also True, this pin change request should be sent immediately after the session containing multi-factor authentication.

Realm
String

SignOn realm used by this message set. The name of the SignOn realm in this message set.

Spaces
Boolean

It indicates whether the password can contain whitespaces.

This does not refer to any special characters. To determine whether special characters are allowed, check the value of Special.

Special
Boolean

It indicates whether the password can contain special characters. Special characters do not include spaces.

UserCred1Q
String

Text prompt for user credential.

If this is present in the server response, a third credential is required to authenticate the user in all future requests. This is in addition to OFXUser and OFXPassword. This new credential is represented by UserCred1A) which is the corresponding answer of UserCred1Q. This should be then included in each request.

UserCred2Q
String

Text prompt for user credential.

If this is present in the server response, a fourth credential is required to authenticate the user in all future requests. This is in addition to OFXUser, OFXPassword and UserCred2Q. This new credential is represented by UserCred2A) which is the corresponding answer of UserCred2Q. This should be then included in each request. In this case, the UserCred1A should also be present in the request.

Constructors

[VB.NET]
Public SignOnDetail()

[C#]
public SignOnDetail();