Create an Asset Report

v1.0.0

The /asset_report/create endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the asset_report_token return value to the /asset_report/get or /asset_report/pdf/get endpoints.

The Asset Report takes some time to be created and is not available immediately after calling /asset_report/create. When the Asset Report is ready to be retrieved using /asset_report/get or /asset_report/pdf/get, Plaid will fire a PRODUCT_READY webhook. For full details of the webhook schema, see .

The /asset_report/create endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the /asset_report/refresh endpoint.

Input

{
  "type": "object",
  "description": "AssetReportCreateRequest defines the request schema for `/asset_report/create`",
  "required": [
    "access_tokens",
    "days_requested"
  ],
  "properties": {
    "access_tokens": {
      "type": "array",
      "description": "An array of access tokens corresponding to the Items that will be included in the report. The `assets` product must have been initialized for the Items during link; the Assets product cannot be added after initialization.",
      "items": {
        "type": "string",
        "description": "The access token associated with the Item data is being requested for."
      }
    },
    "client_id": {
      "type": "string",
      "description": "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
    },
    "days_requested": {
      "type": "integer",
      "description": "The maximum integer number of days of history to include in the Asset Report. If using Fannie Mae Day 1 Certainty, `days_requested` must be at least 61 for new originations or at least 31 for refinancings.\n\nAn Asset Report requested with \"Additional History\" (that is, with more than 61 days of transaction history) will incur an Additional History fee."
    },
    "options": {
      "type": "object",
      "description": "An optional object to filter `/asset_report/create` results. If provided, must be non-`null`. The optional `user` object is required for the report to be eligible for Fannie Mae's Day 1 Certainty program.",
      "properties": {
        "add_ons": {
          "type": "array",
          "description": "Additional information that can be included in the asset report. Possible values: `\"investments\"`, `\"fast_assets\"`",
          "items": {
            "type": "string",
            "description": "A list of add-ons that should be included in the Asset Report",
            "enum": [
              "investments",
              "fast_assets"
            ]
          }
        },
        "client_report_id": {
          "type": "string",
          "description": "Client-generated identifier, which can be used by lenders to track loan applications."
        },
        "include_fast_report": {
          "type": "boolean",
          "description": "true to return balance and identity earlier as a fast report. Defaults to false if omitted."
        },
        "products": {
          "type": "array",
          "description": "Additional information that can be included in the asset report. Possible values: `\"investments\"`",
          "items": {
            "type": "string"
          }
        },
        "user": {
          "type": "object",
          "description": "The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.",
          "properties": {
            "client_user_id": {
              "type": "string",
              "description": "An identifier you determine and submit for the user."
            },
            "email": {
              "type": "string",
              "description": "The user's email address."
            },
            "first_name": {
              "type": "string",
              "description": "The user's first name. Required for the Fannie Mae Day 1 Certainty™ program."
            },
            "last_name": {
              "type": "string",
              "description": "The user's last name.  Required for the Fannie Mae Day 1 Certainty™ program."
            },
            "middle_name": {
              "type": "string",
              "description": "The user's middle name"
            },
            "phone_number": {
              "type": "string",
              "description": "The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\". Phone numbers provided in other formats will be parsed on a best-effort basis."
            },
            "ssn": {
              "type": "string",
              "description": "The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.\n\nFormat: \"ddd-dd-dddd\""
            }
          }
        },
        "webhook": {
          "type": "string",
          "description": "URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready."
        }
      }
    },
    "report_type": {
      "type": "string",
      "description": "When set to `VERIFICATION_OF_EMPLOYMENT` and the Asset Report is added to an Audit Copy Token, the Asset Report will be retrieved by Freddie Mac in the Verification Of Employment (VOE) version instead of the default Verification Of Assets (VOA) version.",
      "enum": [
        "VERIFICATION_OF_EMPLOYMENT"
      ]
    },
    "secret": {
      "type": "string",
      "description": "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
    }
  }
}

Output

{
  "type": "object",
  "description": "AssetReportCreateResponse defines the response schema for `/asset_report/create`",
  "required": [
    "asset_report_id",
    "asset_report_token",
    "request_id"
  ],
  "properties": {
    "asset_report_id": {
      "type": "string",
      "description": "A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive."
    },
    "asset_report_token": {
      "type": "string",
      "description": "A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report."
    },
    "request_id": {
      "type": "string",
      "description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
    }
  }
}