Export Files Job Creator

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 endpoint 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 API.
Path Params
string
required

Specifies a loan for which the entities are exported.

Query Params
boolean

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

boolean

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

Body Params
json
required
Headers
string
required

Bearer token.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json