Preview: V3 Loan Pipeline for Reports

Provides a basis for generating reports from an Encompass loan pipeline that can be accessed through a cursor for reliable paginated data based on a snapshot of a loan pipeline.

Currently available in Preview Mode only.

This API is for loan pipeline report generation. The first call is made without cursor id, which generates a new cursor with the provided filter criteria. The generated cursor id is returned in the response header 'X-Cursor'. The subsequent calls are made with the cursorId provided in the query parameters along with start / limit for pagination.

The filter criteria is cached on the server side and does not need to be passed in when the call is made with cursor id. The cursor expires after 5 minutes of inactivity.

Note: This endpoint is only for report generation. For all real time pipeline results, loan pipeline end point (~/v3/loanPipeline/) should be used.

Usage Notes

  • A maximum of 10 cursors are allowed. Creation of the 11th cursor will result in the removal of the oldest cursor that is marked for expiration.
  • Cursors are flagged for expiration after 5 minutes idle time and have a maximum lifespan of 12 hours.

📘

Note:

  • API endpoints published in Preview mode are not available for production use
  • Preview the API contract (including request and response samples) and provide feedback before the contract becomes official in the upcoming months
  • API Previews are intended for planning and feedback purpose only
  • Postman samples are not published for API Previews

Send us your suggestions for improving this API!

  • Tell us about your thoughts on the API Preview content
  • Does the content supporting API Previews provide you enough information to get a head start in planning for integration? Is it helpful?
  • What do you plan to use this API for?
  • Anything blocking you from using this API once it's production ready?
  • Are there any additions or features you would find useful?
  • Email us with your feedback: [email protected]
Language