Asset Report

assetReportAuditCopyGet

POST
/asset_report/audit_copy/get

/asset_report/audit_copy/get allows auditors to get a copy of an Asset Report that was previously shared via the /asset_report/audit_copy/create endpoint. The caller of /asset_report/audit_copy/create must provide the audit_copy_token to the auditor. This token can then be used to call /asset_report/audit_copy/create.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

AssetReportAuditCopyGetRequest defines the request schema for /asset_report/audit_copy/get

client_id?string

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?string

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.

audit_copy_token*string

The audit_copy_token granting access to the Audit Copy you would like to get.

Response Body

application/json

curl -X POST "https://example.com/asset_report/audit_copy/get" \  -H "Content-Type: application/json" \  -d '{    "audit_copy_token": "string"  }'
{  "report": {    "asset_report_id": "string",    "client_report_id": "string",    "date_generated": "2019-08-24T14:15:22Z",    "days_requested": 0,    "user": {      "client_user_id": "string",      "first_name": "string",      "middle_name": "string",      "last_name": "string",      "ssn": "string",      "phone_number": "string",      "email": "string"    },    "items": [      {        "item_id": "string",        "institution_name": "string",        "institution_id": "string",        "date_last_updated": "2019-08-24T14:15:22Z",        "accounts": [          {            "account_id": "string",            "balances": {              "available": 0,              "current": 0,              "limit": 0,              "iso_currency_code": "string",              "unofficial_currency_code": "string",              "last_updated_datetime": "2019-08-24T14:15:22Z"            },            "mask": "string",            "name": "string",            "official_name": "string",            "type": "investment",            "subtype": "401a",            "verification_status": "automatically_verified",            "days_available": 0,            "transactions": [              {                "transaction_type": "digital",                "pending_transaction_id": "string",                "category_id": "string",                "category": [                  "string"                ],                "location": {                  "address": "string",                  "city": "string",                  "region": "string",                  "postal_code": "string",                  "country": "string",                  "lat": 0,                  "lon": 0,                  "store_number": "string"                },                "payment_meta": {                  "reference_number": "string",                  "ppd_id": "string",                  "payee": "string",                  "by_order_of": "string",                  "payer": "string",                  "payment_method": "string",                  "payment_processor": "string",                  "reason": "string"                },                "account_owner": "string",                "name": "string",                "original_description": "string",                "account_id": "string",                "amount": 0,                "iso_currency_code": "string",                "unofficial_currency_code": "string",                "date": "2019-08-24",                "pending": true,                "transaction_id": "string",                "date_transacted": "string"              }            ],            "owners": [              {                "names": [                  "string"                ],                "phone_numbers": [                  {                    "data": "string",                    "primary": true,                    "type": "home"                  }                ],                "emails": [                  {                    "data": "string",                    "primary": true,                    "type": "primary"                  }                ],                "addresses": [                  {                    "data": {                      "city": "string",                      "region": "string",                      "street": "string",                      "postal_code": "string",                      "country": "string"                    },                    "primary": true                  }                ]              }            ],            "historical_balances": [              {                "date": "2019-08-24",                "current": 0,                "iso_currency_code": "string",                "unofficial_currency_code": "string"              }            ]          }        ]      }    ]  },  "warnings": [    {      "warning_type": "string",      "warning_code": "OWNERS_UNAVAILABLE",      "cause": {        "item_id": "string",        "error": {          "error_type": "INVALID_REQUEST",          "error_code": "string",          "error_message": "string",          "display_message": "string",          "request_id": "string",          "causes": [            {}          ],          "status": 0,          "documentation_url": "string",          "suggested_action": "string"        }      }    }  ],  "request_id": "string"}