Envestnet · Schema

UpdateVerification

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
accountId integer Unique identifier for the account.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification
reason string The reason the account verification failed.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification
verificationStatus string The status of the account verification.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification

Applicable Values
providerAccountId integer Unique identifier for the provider account.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification
verificationType string The account verification type.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification

Applicable Values
account object
transaction array
verificationDate string The date of the account verification.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification
verificationId integer Unique identifier for the verification request.

Endpoints:
  • POST verification
  • GET verification
  • PUT verification
View JSON Schema on GitHub

JSON Schema

envestnet-updateverification-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateVerification",
  "title": "UpdateVerification",
  "required": [
    "transaction"
  ],
  "type": "object",
  "properties": {
    "accountId": {
      "type": "integer",
      "description": "Unique identifier for the account.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>",
      "format": "int64"
    },
    "reason": {
      "type": "string",
      "description": "The reason the account verification failed.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>",
      "readOnly": true,
      "enum": [
        "DATA_NOT_AVAILABLE",
        "ACCOUNT_HOLDER_MISMATCH",
        "FULL_ACCOUNT_NUMBER_AND_BANK_TRANSFER_CODE_NOT_AVAILABLE",
        "FULL_ACCOUNT_NUMBER_NOT_AVAILABLE",
        "BANK_TRANSFER_CODE_NOT_AVAILABLE",
        "EXPIRED",
        "DATA_MISMATCH",
        "INSTRUCTION_GENERATION_ERROR"
      ]
    },
    "verificationStatus": {
      "type": "string",
      "description": "The status of the account verification.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul><br><b>Applicable Values</b>",
      "readOnly": true,
      "enum": [
        "INITIATED",
        "DEPOSITED",
        "SUCCESS",
        "FAILED"
      ]
    },
    "providerAccountId": {
      "type": "integer",
      "description": "Unique identifier for the provider account.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>",
      "format": "int64"
    },
    "verificationType": {
      "type": "string",
      "description": "The account verification type.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul><br><b>Applicable Values</b>",
      "enum": [
        "MATCHING",
        "CHALLENGE_DEPOSIT"
      ]
    },
    "account": {
      "$ref": "#/components/schemas/VerificationAccount"
    },
    "transaction": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VerificationTransaction"
      }
    },
    "verificationDate": {
      "type": "string",
      "description": "The date of the account verification.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>",
      "readOnly": true
    },
    "verificationId": {
      "type": "integer",
      "description": "Unique identifier for the verification request.<br><br><b>Endpoints</b>:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>",
      "format": "int64",
      "readOnly": true
    }
  }
}