plaid

Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.

Changed on

The /credit/freddie_mac/reports/get endpoint retrieves the Verification of Assets and Verification of Employment reports.

post/credit/freddie_mac/reports/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/credit/freddie_mac/reports/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 (VOA) 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 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

    • 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 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

    • info

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