FIProfile Class

Properties   Methods   Events   Config Settings   Errors  

The FIProfile control is a single class that supports the SignOn and FI Profile functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Syntax

FIProfile

Remarks

The FIProfile class provides the ability to download an OFX Financial Institution Profile. These profiles contain information about how to communicate with the financial institution, such as what message sets are supported and what URLs to post to for them as well as the type of data that is supported for sign on.

To use the FIProfile class, first identify the financial institution by setting the FIId, FIOrganization and FIUrl, properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. Use the ClientRouting property to notify the server as to the client's routing capabilities. Finally, set the LastUpdate property to the date of the most recent profile request. Then just call the GetProfile method to retrieve the financial institution's profile.

To determine whether the client has the latest version of the FI profile, the server checks the date and time passed by the client in LastUpdate. If the client has the latest version of the FI profile, the server does not return a profile specific response. In this case, the ServerMessage will contain the message returned by the server (such as: 'Up to date', etc.).

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ChallengeQuestionCount Property (FIProfile Class)

The number of records in the Challenge arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChallengeQuestionCount();
int SetChallengeQuestionCount(int iChallengeQuestionCount);

Unicode (Windows)
INT GetChallengeQuestionCount();
INT SetChallengeQuestionCount(INT iChallengeQuestionCount);

int inebank_fiprofile_getchallengequestioncount(void* lpObj);
int inebank_fiprofile_setchallengequestioncount(void* lpObj, int iChallengeQuestionCount);

int GetChallengeQuestionCount();
int SetChallengeQuestionCount(int iChallengeQuestionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChallengeAggregate
• ChallengeAnswer
• ChallengeQuestion
• ChallengeQuestionId

The array indices start at 0 and end at ChallengeQuestionCount - 1.

This property is not available at design time.

Data Type

Integer

ChallengeAggregate Property (FIProfile Class)

Wrapper for a MFA challenge question.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeAggregate(int iChallengeQuestionIndex);

Unicode (Windows)
LPWSTR GetChallengeAggregate(INT iChallengeQuestionIndex);

char* inebank_fiprofile_getchallengeaggregate(void* lpObj, int challengequestionindex);

QString GetChallengeAggregate(int iChallengeQuestionIndex);

Default Value

""

Remarks

Wrapper for a MFA challenge question.

Each challenge question aggregate contains elements and values associated with the following properties:

• ChallengeQuestionId
• ChallengeQuestion

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class 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 class 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.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeAnswer Property (FIProfile Class)

User's answer to the challenge question identified by QuestionId .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeAnswer(int iChallengeQuestionIndex);
int SetChallengeAnswer(int iChallengeQuestionIndex, const char* lpszChallengeAnswer);

Unicode (Windows)
LPWSTR GetChallengeAnswer(INT iChallengeQuestionIndex);
INT SetChallengeAnswer(INT iChallengeQuestionIndex, LPCWSTR lpszChallengeAnswer);

char* inebank_fiprofile_getchallengeanswer(void* lpObj, int challengequestionindex);
int inebank_fiprofile_setchallengeanswer(void* lpObj, int challengequestionindex, const char* lpszChallengeAnswer);

QString GetChallengeAnswer(int iChallengeQuestionIndex);
int SetChallengeAnswer(int iChallengeQuestionIndex, QString qsChallengeAnswer);

Default Value

""

Remarks

User's answer to the challenge question identified by ChallengeQuestionId.

Depending on the value of ChallengeQuestionId, this answer can be collected by user or client. Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is not available at design time.

Data Type

String

ChallengeQuestion Property (FIProfile Class)

The textual challenge question.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeQuestion(int iChallengeQuestionIndex);

Unicode (Windows)
LPWSTR GetChallengeQuestion(INT iChallengeQuestionIndex);

char* inebank_fiprofile_getchallengequestion(void* lpObj, int challengequestionindex);

QString GetChallengeQuestion(int iChallengeQuestionIndex);

Default Value

""

Remarks

The textual challenge question.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:

Note:Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeQuestionId Property (FIProfile Class)

Identifier for the challenge question.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeQuestionId(int iChallengeQuestionIndex);

Unicode (Windows)
LPWSTR GetChallengeQuestionId(INT iChallengeQuestionIndex);

char* inebank_fiprofile_getchallengequestionid(void* lpObj, int challengequestionindex);

QString GetChallengeQuestionId(int iChallengeQuestionIndex);

Default Value

""

Remarks

Identifier for the challenge question.

This is unique for this challenge question, but not unique for the user, session, etc.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:

Note:Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ClientRouting Property (FIProfile Class)

Client routing capabilities of the Financial Institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientRouting();
int SetClientRouting(int iClientRouting);

Unicode (Windows)
INT GetClientRouting();
INT SetClientRouting(INT iClientRouting);

CR_NONE(0), 
CR_SERVICE(1), 
CR_MESSAGE_SET(2)

int inebank_fiprofile_getclientrouting(void* lpObj);
int inebank_fiprofile_setclientrouting(void* lpObj, int iClientRouting);

int GetClientRouting();
int SetClientRouting(int iClientRouting);

Default Value

0

Remarks

Data Type

Integer

FIAddress1 Property (FIProfile Class)

Street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIAddress1();

Unicode (Windows)
LPWSTR GetFIAddress1();

char* inebank_fiprofile_getfiaddress1(void* lpObj);

QString GetFIAddress1();

Default Value

""

Remarks

The first line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress2 Property (FIProfile Class)

Street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIAddress2();

Unicode (Windows)
LPWSTR GetFIAddress2();

char* inebank_fiprofile_getfiaddress2(void* lpObj);

QString GetFIAddress2();

Default Value

""

Remarks

The second line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress3 Property (FIProfile Class)

Street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIAddress3();

Unicode (Windows)
LPWSTR GetFIAddress3();

char* inebank_fiprofile_getfiaddress3(void* lpObj);

QString GetFIAddress3();

Default Value

""

Remarks

The third line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FICity Property (FIProfile Class)

City.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFICity();

Unicode (Windows)
LPWSTR GetFICity();

char* inebank_fiprofile_getficity(void* lpObj);

QString GetFICity();

Default Value

""

Remarks

The city where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICountry Property (FIProfile Class)

Country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFICountry();

Unicode (Windows)
LPWSTR GetFICountry();

char* inebank_fiprofile_getficountry(void* lpObj);

QString GetFICountry();

Default Value

""

Remarks

The country where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICustomerServicePhone Property (FIProfile Class)

Phone number for Customer Service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFICustomerServicePhone();

Unicode (Windows)
LPWSTR GetFICustomerServicePhone();

char* inebank_fiprofile_getficustomerservicephone(void* lpObj);

QString GetFICustomerServicePhone();

Default Value

""

Remarks

This is the Financial Institution's Customer Service phone number.

This property is read-only.

Data Type

String

FIEmailAddress Property (FIProfile Class)

Email address for contacting the Financial Institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIEmailAddress();

Unicode (Windows)
LPWSTR GetFIEmailAddress();

char* inebank_fiprofile_getfiemailaddress(void* lpObj);

QString GetFIEmailAddress();

Default Value

""

Remarks

The FI email address.

This property is read-only.

Data Type

String

FIHomePage Property (FIProfile Class)

Home web page for general information about the Financial Institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIHomePage();

Unicode (Windows)
LPWSTR GetFIHomePage();

char* inebank_fiprofile_getfihomepage(void* lpObj);

QString GetFIHomePage();

Default Value

""

Remarks

The Financial Institution's home page URL.

This property is read-only.

Data Type

String

FIId Property (FIProfile Class)

Financial institution identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIId();
int SetFIId(const char* lpszFIId);

Unicode (Windows)
LPWSTR GetFIId();
INT SetFIId(LPCWSTR lpszFIId);

char* inebank_fiprofile_getfiid(void* lpObj);
int inebank_fiprofile_setfiid(void* lpObj, const char* lpszFIId);

QString GetFIId();
int SetFIId(QString qsFIId);

Default Value

""

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIName Property (FIProfile Class)

Name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIName();

Unicode (Windows)
LPWSTR GetFIName();

char* inebank_fiprofile_getfiname(void* lpObj);

QString GetFIName();

Default Value

""

Remarks

The name of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIOrganization Property (FIProfile Class)

Financial institution organization name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIOrganization();
int SetFIOrganization(const char* lpszFIOrganization);

Unicode (Windows)
LPWSTR GetFIOrganization();
INT SetFIOrganization(LPCWSTR lpszFIOrganization);

char* inebank_fiprofile_getfiorganization(void* lpObj);
int inebank_fiprofile_setfiorganization(void* lpObj, const char* lpszFIOrganization);

QString GetFIOrganization();
int SetFIOrganization(QString qsFIOrganization);

Default Value

""

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

FIPostalCode Property (FIProfile Class)

Postal Code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIPostalCode();

Unicode (Windows)
LPWSTR GetFIPostalCode();

char* inebank_fiprofile_getfipostalcode(void* lpObj);

QString GetFIPostalCode();

Default Value

""

Remarks

The postal code where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FIProfileDate Property (FIProfile Class)

The date the current profile was posted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIProfileDate();

Unicode (Windows)
LPWSTR GetFIProfileDate();

char* inebank_fiprofile_getfiprofiledate(void* lpObj);

QString GetFIProfileDate();

Default Value

""

Remarks

The date the OFX Financial Institution posted the current profile.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Note: you may use this date on subsequent profile requests to ensure that you receive the latest profile. Simply set the LastUpdate property to the value in this property on any subsequent profile requests.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (FIProfile Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int inebank_fiprofile_getfirewallautodetect(void* lpObj);
int inebank_fiprofile_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (FIProfile Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int inebank_fiprofile_getfirewalltype(void* lpObj);
int inebank_fiprofile_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (FIProfile Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* inebank_fiprofile_getfirewallhost(void* lpObj);
int inebank_fiprofile_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (FIProfile Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* inebank_fiprofile_getfirewallpassword(void* lpObj);
int inebank_fiprofile_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (FIProfile Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int inebank_fiprofile_getfirewallport(void* lpObj);
int inebank_fiprofile_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (FIProfile Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* inebank_fiprofile_getfirewalluser(void* lpObj);
int inebank_fiprofile_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIState Property (FIProfile Class)

State.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIState();

Unicode (Windows)
LPWSTR GetFIState();

char* inebank_fiprofile_getfistate(void* lpObj);

QString GetFIState();

Default Value

""

Remarks

The state or province where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FITechSupportPhone Property (FIProfile Class)

Phone number for Technical Support.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFITechSupportPhone();

Unicode (Windows)
LPWSTR GetFITechSupportPhone();

char* inebank_fiprofile_getfitechsupportphone(void* lpObj);

QString GetFITechSupportPhone();

Default Value

""

Remarks

The Financial Institution's Tech Support department phone number.

This property is read-only.

Data Type

String

FIUrl Property (FIProfile Class)

Financial institution URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIUrl();
int SetFIUrl(const char* lpszFIUrl);

Unicode (Windows)
LPWSTR GetFIUrl();
INT SetFIUrl(LPCWSTR lpszFIUrl);

char* inebank_fiprofile_getfiurl(void* lpObj);
int inebank_fiprofile_setfiurl(void* lpObj, const char* lpszFIUrl);

QString GetFIUrl();
int SetFIUrl(QString qsFIUrl);

Default Value

""

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

Data Type

String

LastUpdate Property (FIProfile Class)

Date and time of the last profile update.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastUpdate();
int SetLastUpdate(const char* lpszLastUpdate);

Unicode (Windows)
LPWSTR GetLastUpdate();
INT SetLastUpdate(LPCWSTR lpszLastUpdate);

char* inebank_fiprofile_getlastupdate(void* lpObj);
int inebank_fiprofile_setlastupdate(void* lpObj, const char* lpszLastUpdate);

QString GetLastUpdate();
int SetLastUpdate(QString qsLastUpdate);

Default Value

"20000101120000.000[+0:GMT]"

Remarks

This is the date (last time) the FI updated the profile on their end. If this is the first time the FIProfile class is being used, use the default value to ensure that the latest update is received. This property must be set to a value that was returned in the FIProfileDate property after a previous profile request.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is not available at design time.

Data Type

String

MessageSetCount Property (FIProfile Class)

The number of records in the MessageSet arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetCount();

Unicode (Windows)
INT GetMessageSetCount();

int inebank_fiprofile_getmessagesetcount(void* lpObj);

int GetMessageSetCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageSetAggregate
• MessageSetClosingInfoAvailability
• MessageSetClosingInfoImage
• MessageSetLanguage
• MessageSetName
• MessageSetRecovery
• MessageSetRefresh
• MessageSetSecurityLevel
• MessageSetServiceProvider
• MessageSetSignOnRealm
• MessageSetSyncMode
• MessageSetTransportSecurity
• MessageSetTxImage
• MessageSetURL
• MessageSetVersion

The array indices start at 0 and end at MessageSetCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MessageSetAggregate Property (FIProfile Class)

Wrapper for a message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetAggregate(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetAggregate(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetaggregate(void* lpObj, int messagesetindex);

QString GetMessageSetAggregate(int iMessageSetIndex);

Default Value

""

Remarks

Wrapper for a message set.

A list of all of a given Financial Institution's supported services are stored in a series of aggregates called 'Message Sets'.

Each message set aggregate contains data (elements and values) associated with the following properties:

• MessageSetName
• MessageSetLanguage
• MessageSetRecovery
• MessageSetRefresh
• MessageSetSecurityLevel
• MessageSetServiceProvider
• MessageSetSignOnRealm
• MessageSetSyncMode
• MessageSetTransportSecurity
• MessageSetURL
• MessageSetVersion

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class 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 class 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.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetClosingInfoAvailability Property (FIProfile Class)

This is an indicator of the Financial Institution's statement closing information capabilities.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetClosingInfoAvailability(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetClosingInfoAvailability(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesetclosinginfoavailability(void* lpObj, int messagesetindex);

bool GetMessageSetClosingInfoAvailability(int iMessageSetIndex);

Default Value

FALSE

Remarks

This is an indicator of the Financial Institution's statement closing information capabilities. If true, the server can support statement closing information download for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetClosingInfoImage Property (FIProfile Class)

This is an indicator of the Financial Institution's statement closing image capabilities.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetClosingInfoImage(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetClosingInfoImage(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesetclosinginfoimage(void* lpObj, int messagesetindex);

bool GetMessageSetClosingInfoImage(int iMessageSetIndex);

Default Value

FALSE

Remarks

This is an indicator of the Financial Institution's statement closing image capabilities. If true, the server can support image of the statement closing information for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetLanguage Property (FIProfile Class)

Languages the server supports.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetLanguage(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetLanguage(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetlanguage(void* lpObj, int messagesetindex);

QString GetMessageSetLanguage(int iMessageSetIndex);

Default Value

""

Remarks

Languages the server supports. More than one may appear in given response.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetName Property (FIProfile Class)

Name of a message set supported by the given FI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetName(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetName(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetname(void* lpObj, int messagesetindex);

QString GetMessageSetName(int iMessageSetIndex);

Default Value

""

Remarks

Name of a message set supported by the given FI.

Each MessageSetAggregate corresponds to a different OFX command. For example, SIGNONMSGSET corresponds to SignOn Request Message. The MessageSetName is used to retrieve the name of the command associated with this Message Set.

The following table lists each message set, along with its aggregate name and the OFX Versions that support it.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetRecovery Property (FIProfile Class)

This is an indicator of the Financial Institution's error-recovery capabilities.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetRecovery(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetRecovery(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesetrecovery(void* lpObj, int messagesetindex);

bool GetMessageSetRecovery(int iMessageSetIndex);

Default Value

FALSE

Remarks

This is an indicator of the Financial Institution's error-recovery capabilities. If true, the server can support file-based error recovery.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetRefresh Property (FIProfile Class)

If true, the server can support Synchronized Refresh.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetRefresh(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetRefresh(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesetrefresh(void* lpObj, int messagesetindex);

bool GetMessageSetRefresh(int iMessageSetIndex);

Default Value

FALSE

Remarks

If true, the server can support Synchronized Refresh. Even if this property is set to false, the Financial Institution's server may still be able to support Lite Synchronization.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetSecurityLevel Property (FIProfile Class)

Security level of the Message Set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetSecurityLevel(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetSecurityLevel(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetsecuritylevel(void* lpObj, int messagesetindex);

QString GetMessageSetSecurityLevel(int iMessageSetIndex);

Default Value

""

Remarks

Security level of the Message Set.

Legal values are defined as follows: "NONE" and "TYPE 1". If the MessageSetSecurityLevel of a Message Set is 'TYPE 1', then the requests for that Message Set submitted to that FI will require a challenge request to be present during the signon.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetServiceProvider Property (FIProfile Class)

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetServiceProvider(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetServiceProvider(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetserviceprovider(void* lpObj, int messagesetindex);

QString GetMessageSetServiceProvider(int iMessageSetIndex);

Default Value

""

Remarks

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetSignOnRealm Property (FIProfile Class)

This is the name of the SignOn realm used by this message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetSignOnRealm(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetSignOnRealm(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetsignonrealm(void* lpObj, int messagesetindex);

QString GetMessageSetSignOnRealm(int iMessageSetIndex);

Default Value

""

Remarks

This is the name of the SignOn realm used by this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetSyncMode Property (FIProfile Class)

Level of synchronization offered by the server for this message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetSyncMode(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetSyncMode(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetsyncmode(void* lpObj, int messagesetindex);

QString GetMessageSetSyncMode(int iMessageSetIndex);

Default Value

""

Remarks

Level of synchronization offered by the server for this message set. The valid values are:

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetTransportSecurity Property (FIProfile Class)

It indicates whether any security measures are taken at the Transport Layer for this message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetTransportSecurity(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetTransportSecurity(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesettransportsecurity(void* lpObj, int messagesetindex);

bool GetMessageSetTransportSecurity(int iMessageSetIndex);

Default Value

FALSE

Remarks

It indicates whether any security measures are taken at the Transport Layer for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetTxImage Property (FIProfile Class)

It indicates whether FI supports transaction image download for this message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSetTxImage(int iMessageSetIndex);

Unicode (Windows)
BOOL GetMessageSetTxImage(INT iMessageSetIndex);

int inebank_fiprofile_getmessagesettximage(void* lpObj, int messagesetindex);

bool GetMessageSetTxImage(int iMessageSetIndex);

Default Value

FALSE

Remarks

It indicates whether FI supports transaction image download for this message set. If True, the server supports transaction image (e.g., check image) for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetURL Property (FIProfile Class)

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetURL(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetURL(INT iMessageSetIndex);

char* inebank_fiprofile_getmessageseturl(void* lpObj, int messagesetindex);

QString GetMessageSetURL(int iMessageSetIndex);

Default Value

""

Remarks

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetVersion Property (FIProfile Class)

This version number corresponds to the version of the OFX Specification which the server uses for the message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSetVersion(int iMessageSetIndex);

Unicode (Windows)
LPWSTR GetMessageSetVersion(INT iMessageSetIndex);

char* inebank_fiprofile_getmessagesetversion(void* lpObj, int messagesetindex);

QString GetMessageSetVersion(int iMessageSetIndex);

Default Value

""

Remarks

This version number corresponds to the version of the OFX Specification which the server uses for the message set. Usually this will be the same version supplied by the client, but sometimes versions may differ across message sets. Servers are required to provide this value in the VER element of the message set aggregate.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

OFXAccessKey Property (FIProfile Class)

Access key value received after a MFA authentication in a previous signon.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey);

Unicode (Windows)
LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);

char* inebank_fiprofile_getofxaccesskey(void* lpObj);
int inebank_fiprofile_setofxaccesskey(void* lpObj, const char* lpszOFXAccessKey);

QString GetOFXAccessKey();
int SetOFXAccessKey(QString qsOFXAccessKey);

Default Value

""

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile class). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (FIProfile Class)

OFX application identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppId();
int SetOFXAppId(const char* lpszOFXAppId);

Unicode (Windows)
LPWSTR GetOFXAppId();
INT SetOFXAppId(LPCWSTR lpszOFXAppId);

char* inebank_fiprofile_getofxappid(void* lpObj);
int inebank_fiprofile_setofxappid(void* lpObj, const char* lpszOFXAppId);

QString GetOFXAppId();
int SetOFXAppId(QString qsOFXAppId);

Default Value

""

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (FIProfile Class)

OFX application version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppVersion();
int SetOFXAppVersion(const char* lpszOFXAppVersion);

Unicode (Windows)
LPWSTR GetOFXAppVersion();
INT SetOFXAppVersion(LPCWSTR lpszOFXAppVersion);

char* inebank_fiprofile_getofxappversion(void* lpObj);
int inebank_fiprofile_setofxappversion(void* lpObj, const char* lpszOFXAppVersion);

QString GetOFXAppVersion();
int SetOFXAppVersion(QString qsOFXAppVersion);

Default Value

""

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (FIProfile Class)

User's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXPassword();
int SetOFXPassword(const char* lpszOFXPassword);

Unicode (Windows)
LPWSTR GetOFXPassword();
INT SetOFXPassword(LPCWSTR lpszOFXPassword);

char* inebank_fiprofile_getofxpassword(void* lpObj);
int inebank_fiprofile_setofxpassword(void* lpObj, const char* lpszOFXPassword);

QString GetOFXPassword();
int SetOFXPassword(QString qsOFXPassword);

Default Value

""

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (FIProfile Class)

The current OFX request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_fiprofile_getofxrequest(void* lpObj);

QString GetOFXRequest();

Default Value

""

Remarks

Polling OFXRequest will cause the class to generate and return an OFX request aggregate.

This property is read-only and not available at design time.

Data Type

String

OFXResponse Property (FIProfile Class)

The current OFX response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXResponse();
int SetOFXResponse(const char* lpszOFXResponse);

Unicode (Windows)
LPWSTR GetOFXResponse();
INT SetOFXResponse(LPCWSTR lpszOFXResponse);

char* inebank_fiprofile_getofxresponse(void* lpObj);
int inebank_fiprofile_setofxresponse(void* lpObj, const char* lpszOFXResponse);

QString GetOFXResponse();
int SetOFXResponse(QString qsOFXResponse);

Default Value

""

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (FIProfile Class)

User's id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXUser();
int SetOFXUser(const char* lpszOFXUser);

Unicode (Windows)
LPWSTR GetOFXUser();
INT SetOFXUser(LPCWSTR lpszOFXUser);

char* inebank_fiprofile_getofxuser(void* lpObj);
int inebank_fiprofile_setofxuser(void* lpObj, const char* lpszOFXUser);

QString GetOFXUser();
int SetOFXUser(QString qsOFXUser);

Default Value

""

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (FIProfile Class)

OFX API version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXVersion();
int SetOFXVersion(const char* lpszOFXVersion);

Unicode (Windows)
LPWSTR GetOFXVersion();
INT SetOFXVersion(LPCWSTR lpszOFXVersion);

char* inebank_fiprofile_getofxversion(void* lpObj);
int inebank_fiprofile_setofxversion(void* lpObj, const char* lpszOFXVersion);

QString GetOFXVersion();
int SetOFXVersion(QString qsOFXVersion);

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

SignOnInfoCount Property (FIProfile Class)

The number of records in the SignOn arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnInfoCount();

Unicode (Windows)
INT GetSignOnInfoCount();

int inebank_fiprofile_getsignoninfocount(void* lpObj);

int GetSignOnInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignOnAggregate
• SignOnAuthToken
• SignOnAuthTokenFirst
• SignOnAuthTokenUrl
• SignOnCaseSensitive
• SignOnCharType
• SignOnClientUIdReq
• SignOnMaxPwdLength
• SignOnMFAChallengeFirst
• SignOnMFAChallengeReq
• SignOnMinPwdLength
• SignOnPINChange
• SignOnPINChangeFirst
• SignOnRealm
• SignOnSpaces
• SignOnSpecial
• SignOnUserCred1Q
• SignOnUserCred2Q

The array indices start at 0 and end at SignOnInfoCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SignOnAggregate Property (FIProfile Class)

Wrapper for signon information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnAggregate(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnAggregate(INT iSignOnIndex);

char* inebank_fiprofile_getsignonaggregate(void* lpObj, int signonindex);

QString GetSignOnAggregate(int iSignOnIndex);

Default Value

""

Remarks

Wrapper for signon information.

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

• SignOnMaxPwdLength
• SignOnMinPwdLength
• SignOnCaseSensitive
• SignOnCharType
• SignOnSpaces
• SignOnSpecial
• SignOnPINChangeFirst
• SignOnPINChange
• SignOnAuthTokenFirst
• SignOnAuthToken
• SignOnAuthTokenUrl
• SignOnClientUIdReq
• SignOnMFAChallengeReq
• SignOnMFAChallengeFirst
• SignOnUserCred1Q
• SignOnUserCred2Q
• SignOnRealm

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class 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 class 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.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnAuthToken Property (FIProfile Class)

Text label for the Authentication Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnAuthToken(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnAuthToken(INT iSignOnIndex);

char* inebank_fiprofile_getsignonauthtoken(void* lpObj, int signonindex);

QString GetSignOnAuthToken(int iSignOnIndex);

Default Value

""

Remarks

Text label for the Authentication Token.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnAuthTokenFirst Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnAuthTokenFirst(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnAuthTokenFirst(INT iSignOnIndex);

int inebank_fiprofile_getsignonauthtokenfirst(void* lpObj, int signonindex);

bool GetSignOnAuthTokenFirst(int iSignOnIndex);

Default Value

FALSE

Remarks

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.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnAuthTokenUrl Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnAuthTokenUrl(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnAuthTokenUrl(INT iSignOnIndex);

char* inebank_fiprofile_getsignonauthtokenurl(void* lpObj, int signonindex);

QString GetSignOnAuthTokenUrl(int iSignOnIndex);

Default Value

""

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnCaseSensitive Property (FIProfile Class)

Indicates whether the password is case-sensitive or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnCaseSensitive(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnCaseSensitive(INT iSignOnIndex);

int inebank_fiprofile_getsignoncasesensitive(void* lpObj, int signonindex);

bool GetSignOnCaseSensitive(int iSignOnIndex);

Default Value

FALSE

Remarks

Indicates whether the password is case-sensitive or not.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnCharType Property (FIProfile Class)

Type of characters the password can contain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnCharType(int iSignOnIndex);

Unicode (Windows)
INT GetSignOnCharType(INT iSignOnIndex);

SCT_ALPHA_ONLY(0), 
SCT_NUMERIC_ONLY(1), 
SCT_ALPHA_OR_NUMERIC(2), 
SCT_ALPHA_AND_NUMERIC(3), 
SCT_UNKNOWN(4)

int inebank_fiprofile_getsignonchartype(void* lpObj, int signonindex);

int GetSignOnCharType(int iSignOnIndex);

Default Value

1

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnClientUIdReq Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnClientUIdReq(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnClientUIdReq(INT iSignOnIndex);

int inebank_fiprofile_getsignonclientuidreq(void* lpObj, int signonindex);

bool GetSignOnClientUIdReq(int iSignOnIndex);

Default Value

FALSE

Remarks

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.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMaxPwdLength Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnMaxPwdLength(int iSignOnIndex);

Unicode (Windows)
INT GetSignOnMaxPwdLength(INT iSignOnIndex);

int inebank_fiprofile_getsignonmaxpwdlength(void* lpObj, int signonindex);

int GetSignOnMaxPwdLength(int iSignOnIndex);

Default Value

0

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnMFAChallengeFirst Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnMFAChallengeFirst(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnMFAChallengeFirst(INT iSignOnIndex);

int inebank_fiprofile_getsignonmfachallengefirst(void* lpObj, int signonindex);

bool GetSignOnMFAChallengeFirst(int iSignOnIndex);

Default Value

FALSE

Remarks

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.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMFAChallengeReq Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnMFAChallengeReq(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnMFAChallengeReq(INT iSignOnIndex);

int inebank_fiprofile_getsignonmfachallengereq(void* lpObj, int signonindex);

bool GetSignOnMFAChallengeReq(int iSignOnIndex);

Default Value

FALSE

Remarks

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.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMinPwdLength Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnMinPwdLength(int iSignOnIndex);

Unicode (Windows)
INT GetSignOnMinPwdLength(INT iSignOnIndex);

int inebank_fiprofile_getsignonminpwdlength(void* lpObj, int signonindex);

int GetSignOnMinPwdLength(int iSignOnIndex);

Default Value

0

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnPINChange Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnPINChange(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnPINChange(INT iSignOnIndex);

int inebank_fiprofile_getsignonpinchange(void* lpObj, int signonindex);

bool GetSignOnPINChange(int iSignOnIndex);

Default Value

FALSE

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnPINChangeFirst Property (FIProfile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnPINChangeFirst(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnPINChangeFirst(INT iSignOnIndex);

int inebank_fiprofile_getsignonpinchangefirst(void* lpObj, int signonindex);

bool GetSignOnPINChangeFirst(int iSignOnIndex);

Default Value

FALSE

Remarks

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 SignOnMFAChallengeFirst is also True, this pin change request should be sent immediately after the session containing multi-factor authentication.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnRealm Property (FIProfile Class)

SignOn realm used by this message set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnRealm(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnRealm(INT iSignOnIndex);

char* inebank_fiprofile_getsignonrealm(void* lpObj, int signonindex);

QString GetSignOnRealm(int iSignOnIndex);

Default Value

""

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnSpaces Property (FIProfile Class)

It indicates whether the password can contain whitespaces.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnSpaces(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnSpaces(INT iSignOnIndex);

int inebank_fiprofile_getsignonspaces(void* lpObj, int signonindex);

bool GetSignOnSpaces(int iSignOnIndex);

Default Value

FALSE

Remarks

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 SignOnSpecial.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnSpecial Property (FIProfile Class)

It indicates whether the password can contain special characters.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignOnSpecial(int iSignOnIndex);

Unicode (Windows)
BOOL GetSignOnSpecial(INT iSignOnIndex);

int inebank_fiprofile_getsignonspecial(void* lpObj, int signonindex);

bool GetSignOnSpecial(int iSignOnIndex);

Default Value

FALSE

Remarks

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

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnUserCred1Q Property (FIProfile Class)

Text prompt for user credential.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnUserCred1Q(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnUserCred1Q(INT iSignOnIndex);

char* inebank_fiprofile_getsignonusercred1q(void* lpObj, int signonindex);

QString GetSignOnUserCred1Q(int iSignOnIndex);

Default Value

""

Remarks

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 SignOnUserCred1Q. This should be then included in each request.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnUserCred2Q Property (FIProfile Class)

Text prompt for user credential.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignOnUserCred2Q(int iSignOnIndex);

Unicode (Windows)
LPWSTR GetSignOnUserCred2Q(INT iSignOnIndex);

char* inebank_fiprofile_getsignonusercred2q(void* lpObj, int signonindex);

QString GetSignOnUserCred2Q(int iSignOnIndex);

Default Value

""

Remarks

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 SignOnUserCred2Q. This new credential is represented by UserCred2A) which is the corresponding answer of SignOnUserCred2Q. This should be then included in each request. In this case, the UserCred1A should also be present in the request.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (FIProfile Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int inebank_fiprofile_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_fiprofile_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FIProfile Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int inebank_fiprofile_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_fiprofile_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FIProfile Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int inebank_fiprofile_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_fiprofile_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (FIProfile Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* inebank_fiprofile_getsslcertstorepassword(void* lpObj);
int inebank_fiprofile_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FIProfile Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int inebank_fiprofile_getsslcertstoretype(void* lpObj);
int inebank_fiprofile_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FIProfile Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* inebank_fiprofile_getsslcertsubject(void* lpObj);
int inebank_fiprofile_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (FIProfile Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int inebank_fiprofile_getsslprovider(void* lpObj);
int inebank_fiprofile_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (FIProfile Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int inebank_fiprofile_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FIProfile Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int inebank_fiprofile_gettimeout(void* lpObj);
int inebank_fiprofile_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Config Method (FIProfile Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inebank_fiprofile_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetProfile Method (FIProfile Class)

Download the message set profile for a given Financial Institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProfile();

Unicode (Windows)
INT GetProfile();

int inebank_fiprofile_getprofile(void* lpObj);

int GetProfile();

Remarks

This function generates the Signon and FIProfile request page, submits it to the financial institution via HTTP, receives the response, and parses it. Individual transactions are downloaded with the statement.

Read-only properties that are populated as a result of response parsing include:

• FIAddress1
• FIAddress2
• FIAddress3
• FICity
• FICountry
• FICustomerServicePhone
• FIEmailAddress
• FIHomePage
• FIName
• FIPostalCode
• FIProfileDate
• FIState
• FITechSupportPhone
• MessageSets
• SignOnDetails

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadOFXDataFile Method (FIProfile Class)

Reads an OFX response from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadOFXDataFile(const char* lpszFileName);

Unicode (Windows)
INT ReadOFXDataFile(LPCWSTR lpszFileName);

int inebank_fiprofile_readofxdatafile(void* lpObj, const char* lpszFileName);

int ReadOFXDataFile(const QString& qsFileName);

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

• FIAddress1
• FIAddress2
• FIAddress3
• FICity
• FICountry
• FICustomerServicePhone
• FIEmailAddress
• FIHomePage
• FIName
• FIPostalCode
• FIProfileDate
• FIState
• FITechSupportPhone
• MessageSets
• SignOnDetails

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RequestChallengeQuestions Method (FIProfile Class)

Download the challenge questions when Multi-Factor Authentication (MFA) is required.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RequestChallengeQuestions();

Unicode (Windows)
INT RequestChallengeQuestions();

int inebank_fiprofile_requestchallengequestions(void* lpObj);

int RequestChallengeQuestions();

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

When sending requests to a FI, if the information in the signon request is correct, but it is not sufficient to authenticate the user, the server can reply with a signon error code of 3000, which indicates that the client must perform multi-factor challenge authentication before proceeding with future OFX requests.

When this error is returned, the user should call this RequestChallengeQuestions method, which request the server to send a list of challenge questions that must be correctly answered before the OFX client may proceed with further OFX requests.

Upon successful response, the server will return a list of challenge questions, stored to ChallengeQuestions, where each question is specified by ChallengeQuestionId and ChallengeQuestion. If the server does not return such list, the class will throw an HTTP 400 error.

The user should inspect the ChallengeQuestions. When this list of challenge questions is returned, then the user has to answer each question by setting the ChallengeAnswer for each ChallengeQuestion, and then call the SendChallengeAnswers method to send the answers back to the server. The class will include these answers within the signon request included as part of the next request message. If these answers are correct, the server will process the request file. If they are incorrect, the server will return an error code of 3001.

When MFA is required, to prevent servers from needing to authenticate the user with each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response. However, the server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request. This allows the server to determine the lifetime of the OFXAccessKey.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

• ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FIProfile Class)

Reset the internal state of the class and all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inebank_fiprofile_reset(void* lpObj);

int Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendChallengeAnswers Method (FIProfile Class)

Send the answers to challenge questions for a Multi-Factor Authentication (MFA).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendChallengeAnswers();

Unicode (Windows)
INT SendChallengeAnswers();

int inebank_fiprofile_sendchallengeanswers(void* lpObj);

int SendChallengeAnswers();

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

When sending requests to a FI, if the information in the signon request is correct, but it is not sufficient to authenticate the user, the server can reply with a signon error code of 3000, which indicates that the client must perform multi-factor challenge authentication before proceeding with future OFX requests.

When this error is returned, the user should call this RequestChallengeQuestions method, which request the server to send a list of challenge questions that must be correctly answered before the OFX client may proceed with further OFX requests.

Upon successful response, the server will return a list of challenge questions, stored to ChallengeQuestions, where each question is specified by ChallengeQuestionId and ChallengeQuestion. If the server does not return such list, the class will throw an HTTP 400 error.

The user should inspect the ChallengeQuestions. When this list of challenge questions is returned, then the user has to answer each question by setting the ChallengeAnswer for each ChallengeQuestion, and then call the SendChallengeAnswers method to send the answers back to the server. The class will include these answers within the signon request included as part of the next request message. If these answers are correct, the server will process the request file. If they are incorrect, the server will return an error code of 3001.

When MFA is required, to prevent servers from needing to authenticate the user with each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response. However, the server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request. This allows the server to determine the lifetime of the OFXAccessKey.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

• ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteOFXDataFile Method (FIProfile Class)

Writes the OFX response sent by the server to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteOFXDataFile(const char* lpszFileName);

Unicode (Windows)
INT WriteOFXDataFile(LPCWSTR lpszFileName);

int inebank_fiprofile_writeofxdatafile(void* lpObj, const char* lpszFileName);

int WriteOFXDataFile(const QString& qsFileName);

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the ReadOFXDataFile method as though it were a live response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectionStatus Event (FIProfile Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(FIProfileConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} FIProfileConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(FIProfileConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FIProfileConnectionStatusEventParams;

#define EID_FIPROFILE_CONNECTIONSTATUS 1

virtual INT INEBANK_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class FIProfileConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(FIProfileConnectionStatusEventParams *e);

// Or, subclass FIProfile and override this emitter function.
virtual int FireConnectionStatus(FIProfileConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Error Event (FIProfile Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FIProfileErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FIProfileErrorEventParams;


Unicode (Windows)
virtual INT FireError(FIProfileErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FIProfileErrorEventParams;

#define EID_FIPROFILE_ERROR 2

virtual INT INEBANK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FIProfileErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FIProfileErrorEventParams *e);

// Or, subclass FIProfile and override this emitter function.
virtual int FireError(FIProfileErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (FIProfile Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FIProfileSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FIProfileSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FIProfileSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FIProfileSSLServerAuthenticationEventParams;

#define EID_FIPROFILE_SSLSERVERAUTHENTICATION 3

virtual INT INEBANK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FIProfileSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FIProfileSSLServerAuthenticationEventParams *e);

// Or, subclass FIProfile and override this emitter function.
virtual int FireSSLServerAuthentication(FIProfileSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FIProfile Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(FIProfileSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FIProfileSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FIProfileSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FIProfileSSLStatusEventParams;

#define EID_FIPROFILE_SSLSTATUS 4

virtual INT INEBANK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FIProfileSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FIProfileSSLStatusEventParams *e);

// Or, subclass FIProfile and override this emitter function.
virtual int FireSSLStatus(FIProfileSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FIProfile Class)