V3 Field Reader

Retrieve values for specific fields in a loan.

Usage Note

📘

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”.

Supported Field Types

  • The fieldReader API supports standard, custom and virtual field IDs.
  • Canonical field IDs are not supported and should not be used.

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.

Language