action plaid_credit_asset_report_freddie_mac_get {
  label: "Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint."
  description: "The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format."
  provider: plaid
  method: POST
  path: "/credit/asset_report/freddie_mac/get"
  encoding: json
  input: {
    type: "object"
    description: "AssetReportFreddieGetRequest 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: "AssetReportFreddieGetResponse defines the response schema for `/asset_report/get`"
    required: ["DEAL", "SchemaVersion", "request_id"]
    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"]
                properties: {
                  LOAN_IDENTIFIERS: {
                    type: "object"
                    description: "Collection of current and previous identifiers for this loan."
                    required: ["LOAN_IDENTIFIER"]
                    properties: {
                      LOAN_IDENTIFIER: {
                        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: "string"
                            description: "The value of the identifier for the specified type."
                          }
                          LoanIdentifierType: {
                            type: "string"
                            description: "A value from a MISMO prescribed list that specifies the type of loan identifier."
                            enum: ["LenderLoan", "UniversalLoan"]
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
          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: "Parent container for name that allows for choice group between parsed and unparsed containers.Parent container for name that allows for choice group between parsed and unparsed containers."
                          required: ["FirstName", "LastName"]
                          properties: {
                            FirstName: {
                              type: "string"
                              description: "The first name of the individual represented by the parent object."
                            }
                            LastName: {
                              type: "string"
                              description: "The last name of the individual represented by the parent object."
                            }
                          }
                        }
                      }
                    }
                    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"
                              description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                              required: ["PartyRoleType"]
                              properties: {
                                PartyRoleType: {
                                  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: "string"
                              description: "A value from a MISMO prescribed list that classifies identification numbers used by the Internal Revenue Service (IRS) in the administration of tax laws. A Social Security number (SSN) is issued by the SSA; all other taxpayer identification numbers are issued by the IRS."
                              enum: ["IndividualTaxpayerIdentificationNumber", "SocialSecurityNumber"]
                            }
                            TaxpayerIdentifierValue: {
                              type: "string"
                              description: "The value of the taxpayer identifier as assigned by the IRS to the individual or legal entity."
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
          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: "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: {
                          ReportingInformationIdentifier: {
                            type: "string"
                            description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                          }
                        }
                      }
                      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"
                            description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                            required: ["ServiceProductFulfillmentIdentifier", "VendorOrderIdentifier"]
                            properties: {
                              ServiceProductFulfillmentIdentifier: {
                                type: "string"
                                description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                                enum: ["VOA", "VOETRANSACTIONS"]
                              }
                              VendorOrderIdentifier: {
                                type: "string"
                                description: "A string that uniquely identifies a type of order Verification of Asset."
                              }
                            }
                          }
                        }
                      }
                      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"
                            description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                            required: ["ASSET"]
                            properties: {
                              ASSET: {
                                type: "array"
                                description: "Documentation not found in the MISMO model viewer and not provided by Freddie Mac."
                                items: {
                                  type: "object"
                                  additionalProperties: true
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
      SchemaVersion: {
        type: "number"
        description: "The Verification Of Assets (aka VOA or Freddie Mac Schema) 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."
      }
    }
  }
}