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.

v1.0.0

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

Input

{
  "type": "object",
  "description": "CreditFreddieMacReportsGetRequest defines the request schema for `credit/asset_report/freddie_mac/get`",
  "required": [
    "audit_copy_token"
  ],
  "properties": {
    "audit_copy_token": {
      "type": "string",
      "description": "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_id": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "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."
    }
  }
}

Output

{
  "type": "object",
  "description": "CreditFreddieMacReportsGetResponse defines the response schema for `/credit/freddie_mac/reports/get`",
  "required": [
    "VOA",
    "request_id"
  ],
  "properties": {
    "VOA": {
      "type": "object",
      "description": "Verification of Assets Report",
      "required": [
        "DEAL",
        "SchemaVersion"
      ],
      "properties": {
        "DEAL": {
          "type": "object",
          "description": "An object representing an Asset Report with Freddie Mac schema.",
          "required": [
            "LOANS",
            "PARTIES",
            "SERVICES"
          ],
          "properties": {
            "LOANS": {
              "type": "object",
              "description": "A collection of loans that are part of a single deal.",
              "required": [
                "LOAN"
              ],
              "properties": {
                "LOAN": {
                  "type": "object",
                  "description": "Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.",
                  "required": [
                    "LOAN_IDENTIFIERS",
                    "LoanRoleType"
                  ],
                  "properties": {
                    "LOAN_IDENTIFIERS": {
                      "type": "object",
                      "description": "Collection of current and previous identifiers for this loan.",
                      "required": [
                        "LOAN_IDENTIFIER"
                      ],
                      "properties": {
                        "LOAN_IDENTIFIER": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "description": "The information used to identify this loan by various parties to the transaction or other organizations.",
                            "required": [
                              "LoanIdentifier",
                              "LoanIdentifierType"
                            ],
                            "properties": {
                              "LoanIdentifier": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "LoanIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    },
                    "LoanRoleType": {
                      "type": "string",
                      "description": "Type of loan. The value can only be \"SubjectLoan\""
                    }
                  }
                }
              }
            },
            "PARTIES": {
              "type": "object",
              "description": "A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect parties such as the credit report provider.",
              "required": [
                "PARTY"
              ],
              "properties": {
                "PARTY": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "description": "A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants such as the flood certificate provider.",
                    "required": [
                      "INDIVIDUAL",
                      "ROLES",
                      "TAXPAYER_IDENTIFIERS"
                    ],
                    "properties": {
                      "INDIVIDUAL": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "NAME"
                        ],
                        "properties": {
                          "NAME": {
                            "type": "object",
                            "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "FirstName",
                              "LastName",
                              "MiddleName"
                            ],
                            "properties": {
                              "FirstName": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "LastName": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "MiddleName": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      },
                      "ROLES": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "ROLE"
                        ],
                        "properties": {
                          "ROLE": {
                            "type": "object",
                            "description": "ADocumentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "ROLE_DETAIL"
                            ],
                            "properties": {
                              "ROLE_DETAIL": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      },
                      "TAXPAYER_IDENTIFIERS": {
                        "type": "object",
                        "description": "The collection of TAXPAYER_IDENTIFICATION elements",
                        "required": [
                          "TAXPAYER_IDENTIFIER"
                        ],
                        "properties": {
                          "TAXPAYER_IDENTIFIER": {
                            "type": "object",
                            "description": "Information about the Taxpayer identification values assigned to the individual or legal entity.Information about the Taxpayer identification values assigned to the individual or legal entity.",
                            "required": [
                              "TaxpayerIdentifierType",
                              "TaxpayerIdentifierValue"
                            ],
                            "properties": {
                              "TaxpayerIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "TaxpayerIdentifierValue": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "SERVICES": {
              "type": "object",
              "description": "A collection of objects that describe requests and responses for services.",
              "required": [
                "SERVICE"
              ],
              "properties": {
                "SERVICE": {
                  "type": "object",
                  "description": "A collection of details related to a fulfillment service or product in terms of request, process and result.",
                  "required": [
                    "STATUSES",
                    "VERIFICATION_OF_ASSET"
                  ],
                  "properties": {
                    "STATUSES": {
                      "type": "object",
                      "description": "A collection of STATUS containers.",
                      "required": [
                        "STATUS"
                      ],
                      "properties": {
                        "STATUS": {
                          "type": "object",
                          "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                          "required": [
                            "StatusCode",
                            "StatusDescription"
                          ],
                          "properties": {
                            "StatusCode": {
                              "type": "string",
                              "description": "Satus Code."
                            },
                            "StatusDescription": {
                              "type": "string",
                              "description": "Status Description."
                            }
                          }
                        }
                      }
                    },
                    "VERIFICATION_OF_ASSET": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "REPORTING_INFORMATION",
                          "SERVICE_PRODUCT_FULFILLMENT",
                          "VERIFICATION_OF_ASSET_RESPONSE"
                        ],
                        "properties": {
                          "REPORTING_INFORMATION": {
                            "type": "object",
                            "description": "Information about an report identifier and a report name.",
                            "required": [
                              "ReportingInformationIdentifier"
                            ],
                            "properties": {
                              "ReportDateTime": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "ReportIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "ReportingInformationIdentifier": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          },
                          "SERVICE_PRODUCT_FULFILLMENT": {
                            "type": "object",
                            "description": "A collection of details related to a fulfillment service or product in terms of request, process and result.",
                            "required": [
                              "SERVICE_PRODUCT_FULFILLMENT_DETAIL"
                            ],
                            "properties": {
                              "SERVICE_PRODUCT_FULFILLMENT_DETAIL": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          },
                          "VERIFICATION_OF_ASSET_RESPONSE": {
                            "type": "object",
                            "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "ASSETS"
                            ],
                            "properties": {
                              "ASSETS": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "SchemaVersion": {
          "type": "number",
          "description": "The Verification Of Assets (VOA) schema version."
        }
      }
    },
    "VOE": {
      "type": "object",
      "description": "Verification of Employment Report",
      "required": [
        "DEAL",
        "SchemaVersion"
      ],
      "properties": {
        "DEAL": {
          "type": "object",
          "description": "An object representing a Verification of Employment report.",
          "required": [
            "LOANS",
            "PARTIES",
            "SERVICES"
          ],
          "properties": {
            "LOANS": {
              "type": "object",
              "description": "A collection of loans that are part of a single deal.",
              "required": [
                "LOAN"
              ],
              "properties": {
                "LOAN": {
                  "type": "object",
                  "description": "Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.",
                  "required": [
                    "LOAN_IDENTIFIERS",
                    "LoanRoleType"
                  ],
                  "properties": {
                    "LOAN_IDENTIFIERS": {
                      "type": "object",
                      "description": "Collection of current and previous identifiers for this loan.",
                      "required": [
                        "LOAN_IDENTIFIER"
                      ],
                      "properties": {
                        "LOAN_IDENTIFIER": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "description": "The information used to identify this loan by various parties to the transaction or other organizations.",
                            "required": [
                              "LoanIdentifier",
                              "LoanIdentifierType"
                            ],
                            "properties": {
                              "LoanIdentifier": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "LoanIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    },
                    "LoanRoleType": {
                      "type": "string",
                      "description": "Type of loan. The value can only be \"SubjectLoan\""
                    }
                  }
                }
              }
            },
            "PARTIES": {
              "type": "object",
              "description": "A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect parties such as the credit report provider.",
              "required": [
                "PARTY"
              ],
              "properties": {
                "PARTY": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "description": "A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants such as the flood certificate provider.",
                    "required": [
                      "INDIVIDUAL",
                      "ROLES",
                      "TAXPAYER_IDENTIFIERS"
                    ],
                    "properties": {
                      "INDIVIDUAL": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "NAME"
                        ],
                        "properties": {
                          "NAME": {
                            "type": "object",
                            "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "FirstName",
                              "LastName",
                              "MiddleName"
                            ],
                            "properties": {
                              "FirstName": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "LastName": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "MiddleName": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      },
                      "ROLES": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "ROLE"
                        ],
                        "properties": {
                          "ROLE": {
                            "type": "object",
                            "description": "ADocumentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "ROLE_DETAIL"
                            ],
                            "properties": {
                              "ROLE_DETAIL": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      },
                      "TAXPAYER_IDENTIFIERS": {
                        "type": "object",
                        "description": "The collection of TAXPAYER_IDENTIFICATION elements",
                        "required": [
                          "TAXPAYER_IDENTIFIER"
                        ],
                        "properties": {
                          "TAXPAYER_IDENTIFIER": {
                            "type": "object",
                            "description": "Information about the Taxpayer identification values assigned to the individual or legal entity.Information about the Taxpayer identification values assigned to the individual or legal entity.",
                            "required": [
                              "TaxpayerIdentifierType",
                              "TaxpayerIdentifierValue"
                            ],
                            "properties": {
                              "TaxpayerIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "TaxpayerIdentifierValue": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "SERVICES": {
              "type": "object",
              "description": "A collection of objects that describe requests and responses for services.",
              "required": [
                "SERVICE"
              ],
              "properties": {
                "SERVICE": {
                  "type": "object",
                  "description": "A collection of details related to a fulfillment service or product in terms of request, process and result.",
                  "required": [
                    "STATUSES",
                    "VERIFICATION_OF_ASSET"
                  ],
                  "properties": {
                    "STATUSES": {
                      "type": "object",
                      "description": "A collection of STATUS containers.",
                      "required": [
                        "STATUS"
                      ],
                      "properties": {
                        "STATUS": {
                          "type": "object",
                          "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                          "required": [
                            "StatusCode",
                            "StatusDescription"
                          ],
                          "properties": {
                            "StatusCode": {
                              "type": "string",
                              "description": "Satus Code."
                            },
                            "StatusDescription": {
                              "type": "string",
                              "description": "Status Description."
                            }
                          }
                        }
                      }
                    },
                    "VERIFICATION_OF_ASSET": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                        "required": [
                          "REPORTING_INFORMATION",
                          "SERVICE_PRODUCT_FULFILLMENT",
                          "VERIFICATION_OF_ASSET_RESPONSE"
                        ],
                        "properties": {
                          "REPORTING_INFORMATION": {
                            "type": "object",
                            "description": "Information about an report identifier and a report name.",
                            "required": [
                              "ReportingInformationIdentifier"
                            ],
                            "properties": {
                              "ReportDateTime": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "ReportIdentifierType": {
                                "type": "object",
                                "additionalProperties": true
                              },
                              "ReportingInformationIdentifier": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          },
                          "SERVICE_PRODUCT_FULFILLMENT": {
                            "type": "object",
                            "description": "A collection of details related to a fulfillment service or product in terms of request, process and result.",
                            "required": [
                              "SERVICE_PRODUCT_FULFILLMENT_DETAIL"
                            ],
                            "properties": {
                              "SERVICE_PRODUCT_FULFILLMENT_DETAIL": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          },
                          "VERIFICATION_OF_ASSET_RESPONSE": {
                            "type": "object",
                            "description": "Documentation not found in the MISMO model viewer and not provided by Freddie Mac.",
                            "required": [
                              "ASSETS"
                            ],
                            "properties": {
                              "ASSETS": {
                                "type": "object",
                                "additionalProperties": true
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "SchemaVersion": {
          "type": "number",
          "description": "The Verification Of Employment (VOE) schema version."
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
    }
  }
}