Export Files Job Creator

post

https://api.elliemae.com/efolder/v1/loans/{loanId}/exportJobsCreator

Use this API to perform a batch export of multiple attachment requests, which can include documents and conditions, in a single API call.

This API added with the 24.3 release of Encompass.

Usage Notes

Unlike the Export Attachments API that only supports a single job request, this batch API supports multiple job requests at a time.
This API returns multiple job IDs for each individual request.
The maximum number of export requests is 10.
The status, including the entityUri to download the attachment, for each file(s) job ID(s), can be requested with the Get Export Status Status API.

Path Params

loanId

string

required

Specifies a loan for which the entities are exported.

Query Params

skipPersonaChecks

boolean

Defaults to false

If set to true, the API skips persona checks. Default value is false.

includeNotActive

boolean

Defaults to false

If set to true, the API returns inactive files along with active files. Default value is false.

Body Params

requestId

string

The unique identifier for the attachment. The request id uniquely identifies the caller's request for the batch export job.

annotationSettings.visibility

array of strings

Defines the visibility that will be applied to the export files. Possible values are the following:

Public - Visible to all users.
Internal - Visible to all Encompass users.
Private - Visible to only the creator of the annotation.

annotationSettings.visibility

ExportEntity

array of objects

Contains metadata information for the export job. Currently supports a 10-job maximum request limit.

ExportEntity

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

200OK