Create Asset Report Audit Copy

v1.0.0

Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.

To grant access to an Audit Copy, use the /asset_report/audit_copy/create endpoint to create an audit_copy_token and then pass that token to the third party who needs access. Each third party has its own auditor_id, for example fannie_mae. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

Input

{
  "type": "object",
  "description": "AssetReportAuditCopyCreateRequest defines the request schema for `/asset_report/audit_copy/get`",
  "required": [
    "asset_report_token"
  ],
  "properties": {
    "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."
    },
    "auditor_id": {
      "type": "string",
      "description": "The `auditor_id` of the third party with whom you would like to share the Asset Report."
    },
    "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."
    },
    "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": "AssetReportAuditCopyCreateResponse defines the response schema for `/asset_report/audit_copy/get`",
  "required": [
    "audit_copy_token",
    "request_id"
  ],
  "properties": {
    "audit_copy_token": {
      "type": "string",
      "description": "A token that can be shared with a third party auditor to allow them to obtain access to the Asset Report. This token should be stored securely."
    },
    "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."
    }
  }
}