GuidesRecipesAPI Reference
Log In
API Reference

đźš§ Create doc package orders for a loan (BETA)

đźš§

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

This endpoint will create a doc package order for each borrower pair on a loan
and process them asynchronously. Poll the index endpoint with the returned
order_group_id to track status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Loan GUID.

Body Params

Available properties for creating doc package orders

string
enum

Doc vendor type enum key.

Allowed:
string
enum

Order type enum key.

Allowed:
recipients
array of objects

The list of additional recipients to be added to the package. Defaults to an empty array.

recipients
string
enum

Disclosure package type enum key.

boolean

Indicates if this is a final or draft package. Only applicable when order type is 'closing'. Defaults to 'false'.

boolean

Indicates if an eNote should be added to the package. Only applicable when order type is 'closing'. Defaults to 'false'.

boolean

Indicates if a previously existing eNote should be used instead of creating a new eNote. Only applicable when order type is 'closing'. Defaults to 'false'.

borrower_pair_ids
array of strings | null

Optional list of borrower pair IDs to create orders for. Only valid pair IDs associated with the loan will be processed. Ignored when order_type is "closing".

borrower_pair_ids
closing_docs_to_remove
array of objects

The list of documents to remove from a closing package. Only applicable when order type is 'closing'. Defaults to an empty array.

closing_docs_to_remove
ron_jurisdiction_info
object

The RON jurisdiction, title agency, and underwriter used to determine where to create
the RON transaction. Only applicable when closing package type is 'HybridRON'.

templates
array of strings

The list of Encompass form/template names to generate (e.g. "Loan Estimate"). Required when order type is 'forms'; ignored otherwise.

templates
Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json