Verified Account Resource
Request-level Data
Attribute Name | Type | Description | Endpoint |
---|---|---|---|
verifiedAccount | entity[] | Details about the verified account. | GET verification/verifiedAccounts |
requestId | string | The unique identifier for the request. | GET verification/verifiedAccounts |
requestDate | dateTime | Indicates the date and time when the request ID is created in the system. | GET verification/verifiedAccounts |
state | string | The state of the verification request. Valid Values: Verified Accounts Verification State |
GET verification/verifiedAccounts |
failedReason | string | The reason for the account verification failed. Valid Values: Verification Request Failed Reason |
GET verification/verifiedAccounts |
Entity: verifiedAccount
Attribute Name | Type | Description | Endpoint |
---|---|---|---|
CONTAINER | string | The type of service, i.e., bank or investment . |
GET verification/verifiedAccounts |
accountId | long | The unique identifier for the account. | GET verification/verifiedAccounts |
displayedName | string | The name or identification of the account owner as it appears at the financial institution (FI) site. Note: The account holder’s name can be full or partial based on how it is displayed on the account summary page of the FI site. In most cases, the FI site does not display the full account holder’s name on the account summary page. |
GET verification/verifiedAccounts |
providerAccountId | long | The unique identifier for the provider account. | GET verification/verifiedAccounts |
accountName | string | The account name as it appears on the site. | GET verification/verifiedAccounts |
accountNumber | string | The account number as it appears on the site. | GET verification/verifiedAccounts |
providerId | string | Identifier of the provider site. The primary key of provider resource. | GET verification/verifiedAccounts |
providerName | string | Service provider or institution name where the account originates. This belongs to the provider resource. | |
accountType | string | The aggregated account type, such as savings, checking, etc. The account type is derived based on the attributes of the account. Valid Values: Aggregated Account Types |
GET verification/verifiedAccounts |
availableBalance | money | The balance in the account that is available for spending. For checking accounts with overdrafts, the available balance may include an overdraft amount if the site adds an overdraft balance to the available balance. Note: Applies only to the bank container. |
GET verification/verifiedAccounts |
currentBalance | money | The balance in the account that is available at the beginning of the business day; is equal to the account's ledger balance. Note: Applies only to the bank container. |
GET verification/verifiedAccounts |
cash | money | The amount that is available for immediate withdrawal or the total amount available to purchase securities in a brokerage or investment account. Note: The cash balance field applies only to brokerage-related accounts. |
GET verification/verifiedAccounts |
balance | money | The total balance of all the investment accounts, as it appears on the FI site. Note: Applies only to the investment container. |
GET verification/verifiedAccounts |
classification | string | The classification of the account, such as personal, corporate, etc., as set by the system. Valid Values: Account Classification |
GET verification/verifiedAccounts |
verificationStatus | string | The status of the account verification. Valid Values: Verified Accounts Verification Status |
GET verification/verifiedAccounts |
failedReason | string | The reason the account verification failed. Valid Values: Verification Account Failed Reason |
GET verification/verifiedAccounts |
isSelected | boolean | Indicates if an account is selected by the user in the FastLink 4 application. | GET verification/verifiedAccounts |
bankTransferCode | entity[] | Bank and branch identification information | GET verification/verifiedAccounts |
fullAccountNumberList | entity | Includes payment account number and unmasked account number. The payment account number is used for ACH or funds transfers. The unmasked account number refers to an account; it is not masked or partially displayed. | GET verification/verifiedAccounts |
holder | entity[] | Holder details of the account. | GET verification/verifiedAccounts |
Entity: fullAccountNumberList
Entity: holder
Attribute Name | Type | Description | Endpoint |
---|---|---|---|
name | name | Name of the account holder. | GET verification/verifiedAccounts |
gender | string | Gender of the account holder. | GET verification/verifiedAccounts |
ownership | string | Indicates the ownership of the account. | GET verification/verifiedAccounts |
Entity: bankTransferCode
Attribute Name | Type | Description | Endpoint |
---|---|---|---|
id | string | The financial institution's branch identification number. Additional Details: The bank account's routing number in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). |
GET verification/verifiedAccounts |
type | string | The bank transfer code type varies depending on the region of the account origination. Valid Values: Bank Transfer Code |
GET verification/verifiedAccounts |
Enum: Bank Transfer Code
Enum: Verified Accounts Verification State
State | Description |
---|---|
COMPLETED | The verification request is completed. |
FAILED | The verification request has failed. |
Enum: Account Classification
Enum: Verified Accounts Verification Status
Verification Status | Description |
---|---|
SUCCESS | The user’s account verification is successful. |
FAILED | The user’s account verification has failed. |
Enum: Verification Request Failed Reason
Enum: Verification Account Failed Reason
Enum: Aggregated Account Types
Container | Account Type |
---|---|
bank | CHECKING Note: For the UK and Australian regions, CHECKING indicates the current account type. |
SAVINGS | |
MONEY_MARKET | |
investment | BROKERAGE_CASH |
BROKERAGE_MARGIN | |
INDIVIDUAL | |
CASH_MANAGEMENT_ACCOUNT | |
BROKERAGE_LINK_ACCOUNT |