Retrieve values for specific fields in a loan.

Usage Notes

📘

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:

1. Date fields are returned in the format of "MM/DD/YYYY". For example, "08/29/2022"
2. Date-time fields that have the timezone indicator stored are returned in the ISO format, in UTC timezone. For example, "2022-08-27 16:57:04Z"
3. Date-time fields that do not have the timezone indicator stored will be returned as a string. For example, "08/29/2022 11:20:28 AM"

Supported Field Types:

• The fieldReader API supports standard, custom and virtual field IDs.
• Canonical field IDs are not supported and should not be used.
• If you do not have permission to a requested field, the field will not be returned.

📘

Effective with release 24.2, the default value for invalid field behavior will be to fail the request, if invalid fields are provided, and the query parameters are not provided. If you need to provide invalid field IDs and receive a blank response back for any reason, field reader can be called with parameter “invalidFieldBehavior” as “Include”.

🚧

Known Issue

The fieldReader API does not currently prevent the user from passing canonical fields as the input for field ID. However, this is not expected behavior and will be corrected in a future release to invalidate canonical fields.