FannieMae

The fannie-mae integration is used to convert to an from the FNM 3.2 File Format

Create a FNMv3.2 Response

Endpoint

Method URI Headers
POST /api/v1/integrations/fannie-mae/fnm-v32 {"Authorization": "Bearer {access_token}"}

Data Params

{
    "data"    : "[loan object]"
}

{success} Success Response

Code: 200

Content

{
  "data"    : "[loan object]"
}

Parse a FNMv3.2 file to an object

Endpoint

Method URI Headers
POST /api/v1/integrations/fannie-mae/fnm-v32/data {"Authorization": "Bearer {access_token}"}

Data Params

{
  "data"    : "[loan object]"
}

{success} Success Response

Code: 200

Content

{
    "data"    : "[loan object]"
}

Loan Object

A loan object consists of 3 core properties, attributes, mapped, and body

  • attributes contain the data values linked directly to their FNM file format field id's, ie: 03A-040
  • mapped contain the data values linked via a readable field key, ie: applicant_first_name
  • body contains the converted body data for a FNMv3.2 file based on the given attributes

Available fields

  • For a full list of available FNM field id's view the array available at: app/Integrations/FannieMae/Services/DataRules.php

  • For a full list of FNM mapped field keys, view the array available at: app/Integrations/FannieMae/Services/DataMapper.php

Example Loan Object

{                                            
  "body":"02A2505 S Creek ST\r\n
          03A           John\r\n
          03A           Mary",
  "attributes":{
    "02A-020": "2505 S Creek ST",
    "03A-040": [
      0:"John",
      1:"Mary"
    ]                                                          
  }                                                            
  "mapped": {
    "property_street_address_2a": "2505 S Creek ST",
    "applicant_first_name": [                         
      0:"John",
      1:"Mary"
    ]                                                          
  }
}