FIProfile Class
Properties Methods Events Configuration 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
class ipworksofx.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 fi_id, fi_organization and fi_url, properties. Next identify the OFX user and application by setting the ofx_user, ofx_password, ofx_app_id and ofx_app_version properties. Use the client_routing property to notify the server as to the client's routing capabilities. Finally, set the last_update property to the date of the most recent profile request. Then just call the get_profile 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 last_update. 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.
| challenge_question_count | The number of records in the Challenge arrays. |
| challenge_aggregate | Wrapper for a MFA challenge question. |
| challenge_answer | User's answer to the challenge question identified by QuestionId . |
| challenge_question | The textual challenge question. |
| challenge_question_id | Identifier for the challenge question. |
| client_routing | Client routing capabilities of the Financial Institution. |
| fi_address1 | Street address. |
| fi_address2 | Street address. |
| fi_address3 | Street address. |
| fi_city | City. |
| fi_country | Country. |
| fi_customer_service_phone | Phone number for Customer Service. |
| fi_email_address | Email address for contacting the Financial Institution. |
| fi_home_page | Home web page for general information about the Financial Institution. |
| fi_id | Financial institution identifier. |
| fi_name | Name. |
| fi_organization | Financial institution organization name. |
| fi_postal_code | Postal Code. |
| fi_profile_date | The date the current profile was posted. |
| firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| firewall_type | This property determines the type of firewall to connect through. |
| firewall_host | This property contains the name or IP address of firewall (optional). |
| firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
| firewall_port | This property contains the TCP port for the firewall Host . |
| firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
| fi_state | State. |
| fi_tech_support_phone | Phone number for Technical Support. |
| fi_url | Financial institution URL. |
| last_update | Date and time of the last profile update. |
| message_set_count | The number of records in the MessageSet arrays. |
| message_set_aggregate | Wrapper for a message set. |
| message_set_closing_info_availability | This is an indicator of the Financial Institution's statement closing information capabilities. |
| message_set_closing_info_image | This is an indicator of the Financial Institution's statement closing image capabilities. |
| message_set_language | Languages the server supports. |
| message_set_name | Name of a message set supported by the given FI. |
| message_set_recovery | This is an indicator of the Financial Institution's error-recovery capabilities. |
| message_set_refresh | If true, the server can support Synchronized Refresh. |
| message_set_security_level | Security level of the Message Set. |
| message_set_service_provider | 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. |
| message_set_sign_on_realm | This is the name of the SignOn realm used by this message set. |
| message_set_sync_mode | Level of synchronization offered by the server for this message set. |
| message_set_transport_security | It indicates whether any security measures are taken at the Transport Layer for this message set. |
| message_set_tx_image | It indicates whether FI supports transaction image download for this message set. |
| message_set_url | This is the address of the server to which OFX (HTTP) connections are made for this particular message set. |
| message_set_version | This version number corresponds to the version of the OFX Specification which the server uses for the message set. |
| ofx_access_key | Access key value received after a MFA authentication in a previous signon. |
| ofx_app_id | OFX application identifier. |
| ofx_app_version | OFX application version. |
| ofx_password | User's password. |
| ofx_request | The current OFX request aggregate. |
| ofx_response | The current OFX response aggregate. |
| ofx_user | User's id. |
| ofx_version | OFX API version. |
| sign_on_info_count | The number of records in the SignOn arrays. |
| sign_on_aggregate | Wrapper for signon information. |
| sign_on_auth_token | Text label for the Authentication Token. |
| sign_on_auth_token_first | Indicates whether server requires clients to send the Authentication Token as part of first signon. |
| sign_on_auth_token_url | URL where Authentication Token information is provided by the institution operating the OFX server. |
| sign_on_case_sensitive | Indicates whether the password is case-sensitive or not. |
| sign_on_char_type | Type of characters the password can contain. |
| sign_on_client_u_id_req | Indicates whether the Client Unique Identifier is required to be included in the signon. |
| sign_on_max_pwd_length | Maximum number of characters a SignOn password on this server can have. |
| sign_on_mfa_challenge_first | Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server. |
| sign_on_mfa_challenge_req | Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server. |
| sign_on_min_pwd_length | Minimum number of characters a SignOn password on this server can have. |
| sign_on_pin_change | It indicates whether the server accepts any PIN Change Requests at all. |
| sign_on_pin_change_first | Indicates whether server requires clients to change password as part of first signon. |
| sign_on_realm | SignOn realm used by this message set. |
| sign_on_spaces | It indicates whether the password can contain whitespaces. |
| sign_on_special | It indicates whether the password can contain special characters. |
| sign_on_user_cred_1q | Text prompt for user credential. |
| sign_on_user_cred_2q | Text prompt for user credential. |
| ssl_accept_server_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| ssl_server_cert_encoded | The certificate (PEM/base64 encoded). |
| timeout | A timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| get_profile | Download the message set profile for a given Financial Institution. |
| read_ofx_data_file | Reads an OFX response from a file. |
| request_challenge_questions | Download the challenge questions when Multi-Factor Authentication (MFA) is required. |
| reset | Reset the internal state of the class and all properties to their default values. |
| send_challenge_answers | Send the answers to challenge questions for a Multi-Factor Authentication (MFA). |
| write_ofx_data_file | Writes the OFX response sent by the server to a file. |
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.
| on_connection_status | Fired to indicate changes in connection state. |
| on_error | Information about errors during data delivery. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AuthToken | Authentication token required for this signon session only. |
| ClientUId | Unique ID identifying OFX Client. |
| CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
| CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
| CurrencyFormat | The format to be used for returning currency values. |
| DateFormat | The format to be used for input and output dates. |
| GetResponseVar | Parses additional information out of the response. |
| NewPassword | New password for the current OFX user. |
| OFXDateFormat | The date format as required by OFX FI server. |
| OFXLog | Log file for the OFX transaction. |
| ServerMessage | Server message if a warning or other information returned. |
| UserCred1A | Additional user credential required by server. |
| UserCred2A | Additional user credential required by server. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |