Download Postman Collection
Guides

Character Encoding Used in Encompass

Suggest Edits

All Encompass Developer Connect APIs available from the developer portal support the UTF-8 variable-length character encoding except for the following services:

  • V1 APIs with the /encompass front door segmentation (e.g. Loan, eFolder). These APIs support the WIN-1252 single-byte character encoding.

Common Questions About Character Encoding in Encompass

  • If a user copy/pastes text that includes UTF-8 characters not supported by WIN-1252 directly into Encompass Smart Client, can the V1 /encompass API operate on that data?
    The WIN-1252 encoding format is a subset of UTF-8 in terms of available characters. If the data includes a character that is NOT supported by WIN-1252, the V1 API will not be operable. However, if the placed characters are also supported by WIN-1252, then the V1 API will be able to process the request/response.

  • If data was added via API using one type of encoding format, can it be retrieved with another API that supports a different encoding format? For example, if a user places loan text data using a V3 API (which supports UTF-8), can I retrieve the same data using V1 API (which only supports WIN-1252)?
    The WIN-1252 is a subset of UTF-8 in terms of available characters. If the data includes a character that is NOT supported by WIN-1252, the V1 API will not be operable. However, if the placed characters are also supported by WIN-1252, then the V1 API will be able to process the request/response.

  • If an API user pushes text data into Encompass with a supported encoding format (WIN-1252 or UTF-8), would all downstream Encompass systems support the text data?
    The Encompass Smart Client uses UTF-8. Therefore, if text data is pushed to Encompass via a V1 /encompass API using WIN-1252 or any other API using UTF-8, the text data will be operable in Encompass Smart Client.

  • Does the API respond with text data in the encoding format that was originally used to push the text?
    The API responds with text data in the native encoding format. For example, if the encoding comes in through V3/encompass API with UTF-8 (or through any app that supports it), the V3 API will respond with UTF-8. Similarly, if the data was updated with WIN-1252 - the V3 API will still respond with UTF-8.

Updated about 1 year ago

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use