The credit/asset_report/freddie_mac/get endpoint retrieves the Asset Report in Freddie Mac's JSON format.
643 matches
46 actions
Plaid
46 actions
- Create a deposit switchPOSTv1.0.0
- Create a deposit switch without using Plaid ExchangePOSTv1.0.0
- Create a new identity verificationPOSTv1.0.0
- Create an Asset ReportPOSTv1.0.0
- Create Asset Report Audit CopyPOSTv1.0.0
- Create Link Delivery sessionPOSTv1.0.0
- Create payment consentPOSTv1.0.0
- Create payment profilePOSTv1.0.0
- Create payment recipientPOSTv1.0.0
- Creates a new end customer for a Plaid reseller.POSTv1.0.0
- Get balance of your Bank Transfer accountPOSTv1.0.0
- Get CategoriesPOSTv1.0.0
- Get details of all supported institutionsPOSTv1.0.0
- Get details of an institutionPOSTv1.0.0
- Get Link Delivery sessionPOSTv1.0.0
- Get payment consentPOSTv1.0.0
- Get payment detailsPOSTv1.0.0
- Get payment profilePOSTv1.0.0
- Get payment recipientPOSTv1.0.0
- List a historical log of user consent eventsPOSTv1.0.0
- List a user’s connected applicationsPOSTv1.0.0
- List dashboard usersPOSTv1.0.0
- List Identity VerificationsPOSTv1.0.0
- List payment recipientsPOSTv1.0.0
- List sweepsPOSTv1.0.0
- Retrieve a dashboard userPOSTv1.0.0
- Retrieve a PDF Asset ReportPOSTv1.0.0
- Retrieve a summary of an individual's employment informationPOSTv1.0.0
- Retrieve a sweepPOSTv1.0.0
- Retrieve a user's payroll informationPOSTv1.0.0
- Retrieve an Asset ReportPOSTv1.0.0
- Retrieve an Asset Report Audit CopyPOSTv1.0.0
- 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.POSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an ItemPOSTv1.0.0
- Retrieve identity dataPOSTv1.0.0
- Retrieve identity match scorePOSTv1.0.0
- Retrieve Identity VerificationPOSTv1.0.0
- Retrieve information about a Plaid applicationPOSTv1.0.0
- Retrieve information from the bank accounts used for employment verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verification in PDF formatPOSTv1.0.0
- Retrieve Link sessions for your userPOSTv1.0.0
- Search employer databasePOSTv1.0.0
- Search institutionsPOSTv1.0.0
- Update the scopes of access for a particular applicationPOSTv1.0.0
Finance/Plaid
Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
{
"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
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
{
"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."
}
}
}