VerifiedAccounts

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VerifiedAccounts",
  "title": "VerifiedAccounts",
  "type": "object",
  "properties": {
    "accountName": {
      "type": "string",
      "description": "The account name as it appears at the site.<br>(The POST accounts service response return this field as name)<br><b>Applicable containers</b>: bank, investment<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "verificationStatus": {
      "type": "string",
      "description": "The status of the account verification.",
      "readOnly": true,
      "enum": [
        "SUCCESS",
        "FAILED"
      ]
    },
    "accountType": {
      "type": "string",
      "description": "The type of account that is aggregated, i.e., savings, checking, charge, HELOC, etc. The account type is derived based on the attributes of the account. <br><b>Valid Values:</b><br><b>Aggregated Account Type</b><br><b>bank</b><ul><li>CHECKING</li><li>SAVINGS</li><li>MONEY_MARKET</li></ul><b>investment (SN 1.0)</b><ul><li>BROKERAGE_MARGIN</li><li>BROKERAGE_CASH</li><li>BROKERAGE_LINK_ACCOUNT</li><li>INDIVIDUAL</li><li>CMA</li></ul><b>investment (SN 2.0)</b><ul><li>BROKERAGE_MARGIN</li><li>BROKERAGE_CASH</li><li>BROKERAGE_LINK_ACCOUNT</li><li>INDIVIDUAL</li><li>CMA</li></ul><ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "currentBalance": {
      "$ref": "#/components/schemas/Money"
    },
    "displayedName": {
      "type": "string",
      "description": "The name or identification of the account owner, as it appears at the FI site. <br><b>Note:</b> The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "holder": {
      "type": "array",
      "description": "Holder details of the account.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/AccountHolder"
      }
    },
    "accountNumber": {
      "type": "string",
      "description": "The account number as it appears on the site. (The POST accounts service response return this field as number)<br><b>Additional Details</b>:<b> Bank / Investment</b>:<br> The account number for the bank account as it appears at the site.<br>In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.<br><b>Applicable containers</b>: bank, investment<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "classification": {
      "type": "string",
      "description": "The classification of the account such as personal, corporate, etc.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<li>GET /verification/verifiedAccounts</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "OTHER",
        "PERSONAL",
        "CORPORATE",
        "SMALL_BUSINESS",
        "TRUST",
        "ADD_ON_CARD",
        "VIRTUAL_CARD"
      ]
    },
    "availableBalance": {
      "$ref": "#/components/schemas/Money"
    },
    "fullAccountNumberList": {
      "$ref": "#/components/schemas/FullAccountNumberList"
    },
    "accountId": {
      "type": "integer",
      "description": "The primary key of the provider account resource.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "accountAgeClassification": {
      "type": "string",
      "description": "Attribute to return the classification of the account age by specifying whether the account is old/new/recent as relevant for a verification use case. If it could not be classified into any one of these values, the attribute would return the value as 'unclassified'",
      "readOnly": true,
      "enum": [
        "UNCLASSIFIED",
        "OLD",
        "NEW",
        "RECENT"
      ]
    },
    "balance": {
      "$ref": "#/components/schemas/Money"
    },
    "providerId": {
      "type": "string",
      "description": "Identifier of the provider site. The primary key of provider resource. <br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "providerAccountId": {
      "type": "integer",
      "description": "The primary key of the provider account resource.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "CONTAINER": {
      "type": "string",
      "description": "The type of service. E.g., Bank, Investment <br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "bank",
        "investment"
      ]
    },
    "isSelected": {
      "type": "boolean",
      "description": "Indicates if an account is selected by the user in the FastLink 4 application",
      "readOnly": true
    },
    "cash": {
      "$ref": "#/components/schemas/Money"
    },
    "bankTransferCode": {
      "type": "array",
      "description": "Bank and branch identification information.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<br><ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/BankTransferCode"
      }
    },
    "providerName": {
      "type": "string",
      "description": "Service provider or institution name where the account originates. This belongs to the provider resource.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<ul><li>GET /verification/verifiedAccounts</li></ul>",
      "readOnly": true
    },
    "failedReason": {
      "type": "string",
      "description": "The reason for the verification failure of the account.",
      "readOnly": true,
      "enum": [
        "REQUIRED_DATA_NOT_AVAILABLE",
        "MATCHING_FAILED"
      ]
    }
  }
}