Use the Field Reader API to view values of loan fields.
Loan Field Data Contract Attributes
Loan fields are defined in the loanFieldDataContract object. The loanFieldDataContract object attributes are described in the following table.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| fieldId string | Loan field ID. |
| value string | Value of the field in the loan. |
| description string | Description for loan field. |
| format string | Indicates the range and format of values the field can store. For example, a field defined as a ZIPCODE field can store up to 10 characters in the format XXXXX-XXXX. NONE is the default. Possible values are: AUDIT CHECK BOX DATE DECIMAL DECIMAL_1 DECIMAL2 DECIMAL3 DECIMAL4 DECIMAL6 DROPDOWN DROPDOWN-Editable INTEGER MONTHDAY PHONE SSN STATE STRING Y/N * ZIPCODE Note: These values are case-sensitive. |
| readOnly boolean | Whether the field is readOnly or is allowed to be edited. |
| type string | Defines the data type of field: date, datetime, decimal, int or string. |
| options array of strings | Represents the possible values for the field id. |
Format of date and date-time values
As part of the Field Reader API response, all the values are returned as string values. However, the formatting is different for various fields:
- Date fields are returned in the format of "MM/DD/YYYY". For example, "08/29/2019"
- Date-time fields that have the timezone indicator stored are returned in the ISO format, in UTC timezone. For example, "2019-08-27 16:57:04Z"
- Date-time fields that do not have the timezone indicator stored will be returned as a string. For example, "08/29/2019 11:20:28 AM"
© ICE Mortgage Technology, Inc. All rights reserved.