Step-by-Step: API Key Generation, Encompass User Creation, and Postman Authentication for Lenders

Follow

Has your team created an API client ID and secret? If not, these can be generated once logged into the Developer Portal. If your organization already has client ID and secret keys, please obtain them from your internal team that manages access. Generating a new set will invalidate any previously generated keys, so keep that in mind!

After authenticating in the Developer Connect Portal, you can generate the keys by navigating to 'My Account' at the top right of the webpage and selecting 'API Key.'

Once you have the keys, create a new user in Encompass. Select the 'API User' option, enter only the client ID in the 'API Client ID' field, and assign the user the Admin persona. Be sure to check 'Access to all loans in the same level' and select the 'Edit' option. Complete the remaining required fields. Note: depending on the endpoints you plan to use, you may need to add all states under Active License.

Next, navigate to the Developer Connect Portal’s Postman page within the Resources section. Follow their step-by-step guide, ensuring you download both the Postman Collection and Environment files. Import both files into Postman, then continue following the provided screenshots for setup.

https://developer.icemortgagetechnology.com/developer-connect/docs/testing-with-postman

When setting up authentication for Developer Connect, it's essential to use the Client Credentials (API User) method. This approach involves creating a dedicated API user within Encompass, ensuring secure and efficient access to the API.

The Resource Owner Password Credentials method is no longer recommended for authenticating with Developer Connect. Instead, it's advisable to use the Client Credentials (API User) flow. This approach involves creating a dedicated API user within Encompass, ensuring secure and efficient access to the API. For detailed guidance on configuring Postman with the Client Credentials flow, refer to the official documentation:
 

If you encounter any issues or would like to schedule a consultation to help with setup, feel free to email us at support@maceinnovations.com.