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.

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

post/credit/freddie_mac/reports/get

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

Changed in 8 of the 53 revisions of this API.13524

  • 94406d9a4d2766See the full diff
    • added the new No enum value to the ////////// response property for the response status

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

    • added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ///////// to the response with the status

      response-optional-property-added

    • added the optional property ///////////// to the response with the status

      response-optional-property-added

    • added the optional property ///////////// to the response with the status

      response-optional-property-added

    • added the required property ///////////// to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5de70cc1e6ca114See the full diff
    • removed the required property ///////////// from the response with the status

      response-required-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog