ProviderAccountDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProviderAccountDetail",
  "title": "ProviderAccountDetail",
  "required": [
    "consentId"
  ],
  "type": "object",
  "properties": {
    "preferences": {
      "$ref": "#/components/schemas/ProviderAccountPreferences"
    },
    "oauthMigrationStatus": {
      "type": "string",
      "description": "Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true,
      "enum": [
        "IN_PROGRESS",
        "TO_BE_MIGRATED",
        "COMPLETED",
        "MIGRATED"
      ]
    },
    "isManual": {
      "type": "boolean",
      "description": "Indicates whether account is a manual or aggregated provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "lastUpdated": {
      "type": "string",
      "description": "Indicate when the providerAccount is last updated successfully.<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "consentId": {
      "type": "integer",
      "description": "Consent Id generated through POST Consent.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "format": "int64"
    },
    "loginForm": {
      "type": "array",
      "description": "This entity gets returned in the response for only MFA based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of MFA form that is displayed to the user in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/LoginForm"
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The date on when the provider account is created in the system.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "readOnly": true
    },
    "aggregationSource": {
      "type": "string",
      "description": "The source through which the providerAccount is added in the system.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "providerId": {
      "type": "integer",
      "description": "Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "requestId": {
      "type": "string",
      "description": "Unique id generated to indicate the request.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "readOnly": true
    },
    "id": {
      "type": "integer",
      "description": "Unique identifier for the provider account resource. This is created during account addition.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "authType": {
      "type": "string",
      "description": "The authentication type enabled at the provider site. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "OAUTH",
        "CREDENTIALS",
        "MFA_CREDENTIALS"
      ]
    },
    "dataset": {
      "type": "array",
      "description": "Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/AccountDataset"
      }
    },
    "status": {
      "type": "string",
      "description": "The status of last update attempted for the account. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "LOGIN_IN_PROGRESS",
        "USER_INPUT_REQUIRED",
        "IN_PROGRESS",
        "PARTIAL_SUCCESS",
        "SUCCESS",
        "FAILED",
        "MIGRATION_IN_PROGRESS",
        "DATA_RETRIEVAL_FAILED"
      ]
    }
  }
}