Verify Challenge Deposit

v1.0.0

The put verification service is used to complete the challenge deposit verification (CDV) process.
This service is used only by the customer of CDV flow.
In the CDV process, the user-provided microtransaction details (i.e., credit and debit) is matched against the microtransactions posted by Yodlee. For a successful verification of the account's ownership both the microtransaction details should match.
The CDV process is currently supported only in the United States.

Notes:

This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.

Input

{
  "type": "object",
  "properties": {
    "verification": {
      "type": "object",
      "required": [
        "transaction"
      ],
      "properties": {
        "account": {
          "type": "object",
          "required": [
            "accountNumber",
            "accountType",
            "bankTransferCode"
          ],
          "properties": {
            "accountName": {
              "type": "string"
            },
            "accountNumber": {
              "type": "string"
            },
            "accountType": {
              "type": "string",
              "enum": [
                "SAVINGS",
                "CHECKING"
              ]
            },
            "bankTransferCode": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The FI's branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). <br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>"
                },
                "type": {
                  "type": "string",
                  "description": "The bank transfer code type varies depending on the region of the account origination. <br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul><b>Applicable Values</b><br>",
                  "enum": [
                    "BSB",
                    "IFSC",
                    "ROUTING_NUMBER",
                    "SORT_CODE"
                  ]
                }
              }
            }
          }
        },
        "accountId": {
          "type": "integer",
          "format": "int64",
          "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>"
        },
        "providerAccountId": {
          "type": "integer",
          "format": "int64",
          "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>"
        },
        "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>",
          "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"
          ]
        },
        "transaction": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "amount",
              "baseType"
            ],
            "properties": {
              "amount": {
                "type": "object",
                "required": [
                  "amount",
                  "currency"
                ],
                "properties": {
                  "amount": {
                    "type": "number",
                    "format": "double"
                  },
                  "currency": {
                    "type": "string",
                    "enum": [
                      "AUD",
                      "BRL",
                      "CAD",
                      "EUR",
                      "GBP",
                      "HKD",
                      "IDR",
                      "INR",
                      "JPY",
                      "NZD",
                      "SGD",
                      "USD",
                      "ZAR",
                      "CNY",
                      "VND",
                      "MYR",
                      "CHF"
                    ]
                  }
                }
              },
              "baseType": {
                "type": "string",
                "enum": [
                  "CREDIT",
                  "DEBIT"
                ]
              }
            }
          }
        },
        "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>"
        },
        "verificationId": {
          "type": "integer",
          "format": "int64",
          "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>"
        },
        "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>",
          "enum": [
            "INITIATED",
            "DEPOSITED",
            "SUCCESS",
            "FAILED"
          ]
        },
        "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"
          ]
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}