Sample - Plaid API
POST/credit/freddie_mac/reports/get

Retrieve Freddie Mac asset and employment reports

Retrieves Freddie Mac Verification of Assets and, when available, Verification of Employment reports. Supply the required audit_copy_token and provide API credentials through the request body or the corresponding headers. The response contains the Freddie Mac DEAL structure and the request schema version.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Request credentials and the audit-copy token used to retrieve Freddie Mac Verification of Assets and Verification of Employment reports.

audit_copy_tokenstringrequired
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_idstringoptional
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.
secretstringoptional
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.

2 status codes
200Returns the Freddie Mac `DEAL` structure, including `LOANS`, `PARTIES`, and `SERVICES`, together with the request identifier and `SchemaVersion`.
DEALobjectrequired
An object representing an Asset Report with Freddie Mac schema.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
SchemaVersionnumberrequired
The Verification Of Assets (VOA) schema version.
defaultReturns an error object containing an `error_type`, `error_code`, `error_message`, and `display_message`; use `error_code` to identify the specific failure.
error_typestringrequired
A broad categorization of the error. Safe for programmatic use.
Allowed:INVALID_REQUESTINVALID_RESULTINVALID_INPUTINSTITUTION_ERRORRATE_LIMIT_EXCEEDEDAPI_ERRORITEM_ERRORASSET_REPORT_ERRORBASE_REPORT_ERRORRECAPTCHA_ERROROAUTH_ERRORPAYMENT_ERROR
error_codestringrequired
The particular error code. Safe for programmatic use.
error_code_reasonstringoptional
The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection.
error_messagestringrequired
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagestringrequired
A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.
request_idstringoptional
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarrayoptional
In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.
statusintegeroptional
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstringoptional
The URL of a Plaid documentation page with more information about the error
suggested_actionstringoptional
Suggested steps for resolving the error
required_account_subtypesarray<string>optional
A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.
provided_account_subtypesarray<string>optional
A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

Error handling

audit_copy_token is required and must identify an accessible Asset Report audit copy. client_id and secret may be supplied in the request body or their corresponding headers, and this endpoint is intended only for Freddie Mac integrations.