QFD can integrate either via REST or SOAP API using real time API calls to the system of record in order to search for and retain useful account information.
Account Search:
Please note: QFD only supports looking up a list of accounts by the unique customer id.
In order for QFD to display search results, and to retain other The following data points will need to be returned from the account search API call, so that QFD can display the list of accounts on the UI, in order for the end user to confidently select the correct account to create the claim against.
Field | Required? |
|---|---|
Account Number | Yes (Unique account number that would identifies a customer’s account) |
Description | Yes (ex: Checking, Business Checking, Student Checking, etc.) |
Account Type | No (Indicates if the account is for deposits, credit cards, etc. This can be inferred by QFD using the Account Type Code if needed) |
Account Type Code* | Yes (Alphanumeric or numeric code, that does not change, that relates to the account type denoted in the Description, ex: 001 = Checking) |
Account Name | No |
Account Nickname | No (Can be used on the UI in place of the Description for easier account identification, sometimes enabled for those with online banking) |
*The account type code field can be used to limit the types of accounts that a claim can be submitted against. To ensure QFD correctly displays the desired accounts in the selection list during claim creation, please provide a list of all the account codes that the API can return, and indicate which ones should and should not be visible for selection.
Account Lookup:
Note: This can leverage the same API call as Account Search, if the API supports being able to query based on EITHER a unique customer id OR a unique account number.
In order for QFD to retain needed account information, we will need as many of the following data points as possible to be made available from the API response:
Field | Required? |
|---|---|
Account Number | Yes |
Account Type |
No (Indicates if the account is for deposits, credit cards, etc. This can be inferred by QFD using the Account Type Code if needed) | |
Account Type Code* | Yes - A unique unchanging code that denotes the type of account (Checking, Business Checking, etc.) |
Description | Yes |
Account Status | Yes |
Account Status Code | No |
Account Name | No |
Account Nickname | No |
Account Open Date | No |
Account Closed Date | No |
Balance | No |
Statement Cycle Date | No |
Is Account Enrolled in Auto Pay | No |
Is Overdraft Protection Enabled | No |
Card Number | Yes - Unless returning Card ID |
Card ID | Yes - if API is returning Card ID, we will need a service to look up the full card number using the Card ID. |
Card Holder Name | No - if card data not provided here, we will need to know which API has it instead. |
Card Issue Date | No - if card data not provided here, we will need to know which API has it instead. |
Card Expiration Date | No - if card data not provided here, we will need to know which API has it instead. |
Card Status | No - if card data not provided here, we will need to know which API has it instead |
...
. |