plaid

Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.

Changed on

The /credit/asset_report/freddie_mac/get endpoint retrieves the Asset Report in Freddie Mac's JSON format.

post/credit/asset_report/freddie_mac/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/credit/asset_report/freddie_mac/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

audit_copy_tokenstring required

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.

client_idstring

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.

secretstring

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.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

SchemaVersionnumber required

The Verification Of Assets (aka VOA or Freddie Mac Schema) schema version.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 94406d9a4d27Revision changes
    • warning

      added the new No enum value to the ///////// response property for the response status

    • warning

      added the new No enum value to the ///////// response property for the response status

    • warning

      added the new Yes enum value to the ///////// response property for the response status

    • warning

      added the new Yes enum value to the ///////// response property for the response status

    • info

      removed the false enum value from the ///////// response property for the response status

    • info

      removed the false enum value from the ///////// response property for the response status

    • info

      removed the true enum value from the ///////// response property for the response status

    • info

      removed the true enum value from the ///////// response property for the response status