OFXAccessKey Property

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

Syntax

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey); Unicode (Windows) LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);
@property (nonatomic,readwrite,assign,getter=OFXAccessKey,setter=setOFXAccessKey:) NSString* OFXAccessKey;
- (NSString*)OFXAccessKey;
- (void)setOFXAccessKey:(NSString*)newOFXAccessKey;
#define PID_CCSTATEMENT_OFXACCESSKEY 36

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_CCStatement_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_CCStatement_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

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

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 C++ Edition - Version 20.0 [Build 7941]